Pipefork Management MCP is an MCP server published by com.pipefork, hosted at www.pipefork.com. When last checked on 2026-11-22 it was working: it answers and lists its tools. It declares 27 tools, including api_list, api_get, api_create, draft_get, draft_validate.
Manage Pipefork API projects, drafts, connections, secrets, and deployments through MCP.
646 connections through 4 shared values. Tap any node.
Inferred from the host name and headers: what a server runs on, not who runs it.
List APIs the authenticated caller may access in the current workspace.
| Parameter | Type | Description |
|---|---|---|
| mode | string | one of ["active","archived"] |
{
"name": "api_list",
"title": "List APIs",
"description": "List APIs the authenticated caller may access in the current workspace.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"mode": {
"enum": [
"active",
"archived"
],
"type": "string",
"default": "active"
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"result"
],
"properties": {
"result": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"name",
"slug",
"description",
"status",
"createdAt",
"updatedAt"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"slug": {
"type": "string"
},
"status": {
"enum": [
"active",
"archived",
"pending_deletion",
"deleted"
],
"type": "string"
},
"createdAt": {
"type": "string"
},
"updatedAt": {
"type": "string"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}
}
},
"annotations": {
"readOnlyHint": true,
"openWorldHint": false,
"destructiveHint": false
}
}None yet. Changes appear after a server's second daily check.
Squares are this server's values; dots are other servers sharing them. A shared address or publisher is a lead, not proof of a common operator.
Get one API by its stable API ID.
| Parameter | Type | Description |
|---|---|---|
| apiId * | string |
{
"name": "api_get",
"title": "Get API",
"description": "Get one API by its stable API ID.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"apiId"
],
"properties": {
"apiId": {
"type": "string",
"minLength": 1
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id",
"name",
"slug",
"description",
"status",
"createdAt",
"updatedAt",
"allowedOrigins",
"hasProdDeploymentHistory",
"environments"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"slug": {
"type": "string"
},
"status": {
"enum": [
"active",
"archived",
"pending_deletion",
"deleted"
],
"type": "string"
},
"createdAt": {
"type": "string"
},
"updatedAt": {
"type": "string"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"environments": {
"type": "object",
"required": [
"dev",
"test",
"prod"
],
"propertyNames": {
"enum": [
"dev",
"test",
"prod"
],
"type": "string"
},
"additionalProperties": {
"type": "object",
"required": [
"name",
"status",
"deployed",
"version",
"deployedAt"
],
"properties": {
"name": {
"enum": [
"dev",
"test",
"prod"
],
"type": "string"
},
"status": {
"enum": [
"active",
"disabled"
],
"type": "string"
},
"version": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"deployed": {
"type": "boolean"
},
"deployedAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
}
},
"allowedOrigins": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"hasProdDeploymentHistory": {
"type": "boolean"
}
},
"additionalProperties": false
},
"annotations": {
"readOnlyHint": true,
"openWorldHint": false,
"destructiveHint": false
}
}Create an API in the authenticated caller workspace.
| Parameter | Type | Description |
|---|---|---|
| name * | string | |
| slug | string | |
| description | any |
{
"name": "api_create",
"title": "Create API",
"description": "Create an API in the authenticated caller workspace.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"minLength": 1
},
"slug": {
"type": "string",
"pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$",
"minLength": 2
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id",
"name",
"slug",
"description",
"status",
"createdAt",
"updatedAt",
"allowedOrigins",
"hasProdDeploymentHistory",
"environments"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"slug": {
"type": "string"
},
"status": {
"enum": [
"active",
"archived",
"pending_deletion",
"deleted"
],
"type": "string"
},
"createdAt": {
"type": "string"
},
"updatedAt": {
"type": "string"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"environments": {
"type": "object",
"required": [
"dev",
"test",
"prod"
],
"propertyNames": {
"enum": [
"dev",
"test",
"prod"
],
"type": "string"
},
"additionalProperties": {
"type": "object",
"required": [
"name",
"status",
"deployed",
"version",
"deployedAt"
],
"properties": {
"name": {
"enum": [
"dev",
"test",
"prod"
],
"type": "string"
},
"status": {
"enum": [
"active",
"disabled"
],
"type": "string"
},
"version": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"deployed": {
"type": "boolean"
},
"deployedAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
}
},
"allowedOrigins": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"hasProdDeploymentHistory": {
"type": "boolean"
}
},
"additionalProperties": false
},
"annotations": {
"readOnlyHint": false,
"openWorldHint": false,
"destructiveHint": false
}
}Retrieve the current canonical draft for an API by its stable API ID.
| Parameter | Type | Description |
|---|---|---|
| apiId * | string |
{
"name": "draft_get",
"title": "Get API draft",
"description": "Retrieve the current canonical draft for an API by its stable API ID.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"apiId"
],
"properties": {
"apiId": {
"type": "string",
"minLength": 1
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"result"
],
"properties": {
"result": {
"anyOf": [
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
{
"type": "null"
}
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}
}
},
"annotations": {
"readOnlyHint": true,
"openWorldHint": false,
"destructiveHint": false
}
}Validate the current canonical draft for an API by its stable API ID.
| Parameter | Type | Description |
|---|---|---|
| apiId * | string |
{
"name": "draft_validate",
"title": "Validate API draft",
"description": "Validate the current canonical draft for an API by its stable API ID.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"apiId"
],
"properties": {
"apiId": {
"type": "string",
"minLength": 1
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"valid",
"errors",
"warnings"
],
"properties": {
"valid": {
"type": "boolean"
},
"errors": {
"type": "array",
"items": {
"type": "string"
}
},
"warnings": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
},
"annotations": {
"readOnlyHint": true,
"openWorldHint": false,
"destructiveHint": false
}
}Create a structured endpoint in an API draft.
| Parameter | Type | Description |
|---|---|---|
| path * | string | |
| apiId * | string | |
| method * | string | one of ["GET","POST","PUT","PATCH","DELETE"] |
| endpointId * | string | |
| initialStepId | string | |
| queryParameters | array |
{
"name": "endpoint_create",
"title": "Create endpoint",
"description": "Create a structured endpoint in an API draft.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"endpointId",
"method",
"path",
"apiId"
],
"properties": {
"path": {
"type": "string",
"pattern": "^\\/.*"
},
"apiId": {
"type": "string",
"minLength": 1
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
],
"type": "string"
},
"endpointId": {
"type": "string",
"minLength": 1
},
"initialStepId": {
"type": "string",
"minLength": 1
},
"queryParameters": {
"type": "array",
"items": {
"type": "object",
"required": [
"name",
"required"
],
"properties": {
"name": {
"type": "string",
"minLength": 1
},
"type": {
"enum": [
"string",
"number",
"integer",
"boolean"
],
"type": "string"
},
"required": {
"type": "boolean"
},
"description": {
"type": "string",
"minLength": 1
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"annotations": {
"readOnlyHint": false,
"openWorldHint": false,
"destructiveHint": false
}
}Update a structured endpoint in an API draft.
| Parameter | Type | Description |
|---|---|---|
| path | string | |
| apiId * | string | |
| method | string | one of ["GET","POST","PUT","PATCH","DELETE"] |
| examples | object | |
| response | object | |
| agentTool | object | |
| endpointId * | string | |
| deprecation | object | |
| queryParameters | array |
{
"name": "endpoint_update",
"title": "Update endpoint",
"description": "Update a structured endpoint in an API draft.",
"inputSchema": {
"type": "object",
"$defs": {
"__schema0": {
"type": "object",
"properties": {
"enum": {
"type": "array",
"items": {}
},
"type": {
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"items": {
"$ref": "#/$defs/__schema0"
},
"default": {},
"example": {},
"nullable": {
"type": "boolean"
},
"required": {
"type": "array",
"items": {
"type": "string"
}
},
"properties": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/$defs/__schema0"
}
},
"description": {
"type": "string"
},
"additionalProperties": {
"anyOf": [
{
"type": "boolean"
},
{
"$ref": "#/$defs/__schema0"
}
]
}
},
"additionalProperties": {}
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"endpointId",
"apiId"
],
"properties": {
"path": {
"type": "string",
"pattern": "^\\/.*"
},
"apiId": {
"type": "string",
"minLength": 1
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
],
"type": "string"
},
"examples": {
"type": "object",
"properties": {
"request": {
"type": "object",
"properties": {
"body": {},
"query": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"params": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"headers": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
}
}
},
"response": {}
}
},
"response": {
"type": "object",
"required": [
"mode",
"code"
],
"properties": {
"code": {
"type": "string",
"minLength": 1
},
"mode": {
"type": "string",
"const": "javascript"
},
"schema": {
"$ref": "#/$defs/__schema0"
},
"example": {},
"statusCode": {
"type": "integer",
"maximum": 599,
"minimum": 100
},
"validateInRuntime": {
"type": "boolean"
}
},
"additionalProperties": false
},
"agentTool": {
"type": "object",
"required": [
"enabled",
"toolName",
"toolDescription",
"inputSchema",
"outputSchema",
"errorSemantics"
],
"properties": {
"enabled": {
"type": "boolean"
},
"toolName": {
"type": "string",
"pattern": "^[a-zA-Z][a-zA-Z0-9_]*$"
},
"whenToUse": {
"type": "string",
"minLength": 1
},
"inputSchema": {
"$ref": "#/$defs/__schema0"
},
"outputSchema": {
"$ref": "#/$defs/__schema0"
},
"errorSemantics": {
"type": "array",
"items": {
"enum": [
"validation_failed",
"unauthorized",
"rate_limited",
"upstream_unavailable",
"upstream_timeout",
"composer_failed",
"internal_error"
],
"type": "string"
},
"minItems": 1
},
"examplePrompts": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
},
"default": []
},
"toolDescription": {
"type": "string",
"minLength": 1
}
}
},
"endpointId": {
"type": "string",
"minLength": 1
},
"deprecation": {
"type": "object",
"required": [
"deprecated"
],
"properties": {
"message": {
"type": "string"
},
"deprecated": {
"type": "boolean"
},
"replacedBy": {
"type": "string"
}
}
},
"queryParameters": {
"type": "array",
"items": {
"type": "object",
"required": [
"name",
"required"
],
"properties": {
"name": {
"type": "string",
"minLength": 1
},
"type": {
"enum": [
"string",
"number",
"integer",
"boolean"
],
"type": "string"
},
"required": {
"type": "boolean"
},
"description": {
"type": "string",
"minLength": 1
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"annotations": {
"readOnlyHint": false,
"openWorldHint": false,
"destructiveHint": true
}
}Delete a structured endpoint from an API draft.
| Parameter | Type | Description |
|---|---|---|
| apiId * | string | |
| endpointId * | string |
{
"name": "endpoint_delete",
"title": "Delete endpoint",
"description": "Delete a structured endpoint from an API draft.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"endpointId",
"apiId"
],
"properties": {
"apiId": {
"type": "string",
"minLength": 1
},
"endpointId": {
"type": "string",
"minLength": 1
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"annotations": {
"readOnlyHint": false,
"openWorldHint": false,
"destructiveHint": true
}
}Create a supported structured step in an API draft endpoint.
| Parameter | Type | Description |
|---|---|---|
| step * | any | |
| apiId * | string | |
| stepId * | string | |
| endpointId * | string |
{
"name": "step_create",
"title": "Create endpoint step",
"description": "Create a supported structured step in an API draft endpoint.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"apiId",
"endpointId",
"stepId",
"step"
],
"properties": {
"step": {
"oneOf": [
{
"type": "object",
"required": [
"type",
"outputName",
"method"
],
"properties": {
"url": {
"type": "string",
"minLength": 1
},
"body": {
"oneOf": [
{
"type": "object",
"required": [
"mode",
"value"
],
"properties": {
"mode": {
"type": "string",
"const": "json"
},
"value": {}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"mode",
"code"
],
"properties": {
"code": {
"type": "string",
"minLength": 1
},
"mode": {
"type": "string",
"const": "javascript"
}
},
"additionalProperties": false
}
]
},
"type": {
"type": "string",
"const": "http_request"
},
"query": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "string"
}
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
],
"type": "string"
},
"headers": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "string"
}
},
"onError": {
"enum": [
"stop",
"continue",
"fallback"
],
"type": "string"
},
"condition": {
"type": "object",
"required": [
"enabled"
],
"properties": {
"enabled": {
"type": "boolean"
},
"expression": {
"type": "string"
}
},
"additionalProperties": false
},
"timeoutMs": {
"type": "integer",
"maximum": 60000,
"minimum": 100
},
"outputName": {
"type": "string",
"pattern": "^[a-zA-Z][a-zA-Z0-9_]*$"
},
"connectionId": {
"type": "string",
"minLength": 1
},
"relativePath": {
"type": "string",
"minLength": 1
},
"authProfileId": {
"type": "string",
"minLength": 1
},
"fallbackValue": {},
"parallelGroup": {
"type": "string",
"pattern": "^[a-zA-Z][a-zA-Z0-9_-]*$"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"type",
"outputName",
"value"
],
"properties": {
"type": {
"type": "string",
"const": "static_json"
},
"value": {},
"outputName": {
"type": "string",
"pattern": "^[a-zA-Z][a-zA-Z0-9_]*$"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"type",
"outputName",
"code"
],
"properties": {
"code": {
"type": "string",
"minLength": 1
},
"type": {
"type": "string",
"const": "compute"
},
"outputName": {
"type": "string",
"pattern": "^[a-zA-Z][a-zA-Z0-9_]*$"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"type",
"outputName",
"promptTemplate"
],
"properties": {
"type": {
"type": "string",
"const": "llm_provider"
},
"timeoutMs": {
"type": "integer",
"maximum": 60000,
"minimum": 100
},
"outputName": {
"type": "string",
"pattern": "^[a-zA-Z][a-zA-Z0-9_]*$"
},
"temperature": {
"type": "number",
"maximum": 2,
"minimum": 0
},
"promptTemplate": {
"type": "string",
"minLength": 1
},
"responseFormat": {
"type": "object",
"properties": {
"type": {
"enum": [
"text",
"json"
],
"type": "string"
},
"schema": {}
},
"additionalProperties": false
},
"maxOutputTokens": {
"type": "integer",
"maximum": 1000000,
"minimum": 1
},
"systemPromptTemplate": {
"type": "string"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"type",
"outputName",
"source",
"operations"
],
"properties": {
"type": {
"type": "string",
"const": "transform"
},
"source": {
"type": "string",
"minLength": 1
},
"operations": {
"type": "array",
"items": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"minItems": 1
},
"outputName": {
"type": "string",
"pattern": "^[a-zA-Z][a-zA-Z0-9_]*$"
},
"maxOutputItems": {
"type": "integer",
"maximum": 100000,
"minimum": 1
}
},
"additionalProperties": false
}
]
},
"apiId": {
"type": "string",
"minLength": 1
},
"stepId": {
"type": "string",
"minLength": 1
},
"endpointId": {
"type": "string",
"minLength": 1
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"annotations": {
"readOnlyHint": false,
"openWorldHint": false,
"destructiveHint": false
}
}Update a supported structured step in an API draft endpoint.
| Parameter | Type | Description |
|---|---|---|
| step * | any | |
| apiId * | string | |
| stepId * | string | |
| endpointId * | string |
{
"name": "step_update",
"title": "Update endpoint step",
"description": "Update a supported structured step in an API draft endpoint.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"apiId",
"endpointId",
"stepId",
"step"
],
"properties": {
"step": {
"oneOf": [
{
"type": "object",
"required": [
"type"
],
"properties": {
"url": {
"type": "string",
"minLength": 1
},
"body": {
"oneOf": [
{
"type": "object",
"required": [
"mode",
"value"
],
"properties": {
"mode": {
"type": "string",
"const": "json"
},
"value": {}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"mode",
"code"
],
"properties": {
"code": {
"type": "string",
"minLength": 1
},
"mode": {
"type": "string",
"const": "javascript"
}
},
"additionalProperties": false
}
]
},
"type": {
"type": "string",
"const": "http_request"
},
"query": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "string"
}
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
],
"type": "string"
},
"headers": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "string"
}
},
"onError": {
"enum": [
"stop",
"continue",
"fallback"
],
"type": "string"
},
"condition": {
"type": "object",
"required": [
"enabled"
],
"properties": {
"enabled": {
"type": "boolean"
},
"expression": {
"type": "string"
}
},
"additionalProperties": false
},
"timeoutMs": {
"type": "integer",
"maximum": 60000,
"minimum": 100
},
"outputName": {
"type": "string",
"pattern": "^[a-zA-Z][a-zA-Z0-9_]*$"
},
"connectionId": {
"type": "string",
"minLength": 1
},
"relativePath": {
"type": "string",
"minLength": 1
},
"authProfileId": {
"type": "string",
"minLength": 1
},
"fallbackValue": {},
"parallelGroup": {
"type": "string",
"pattern": "^[a-zA-Z][a-zA-Z0-9_-]*$"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"type": "string",
"const": "static_json"
},
"value": {},
"outputName": {
"type": "string",
"pattern": "^[a-zA-Z][a-zA-Z0-9_]*$"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"type"
],
"properties": {
"code": {
"type": "string",
"minLength": 1
},
"type": {
"type": "string",
"const": "compute"
},
"outputName": {
"type": "string",
"pattern": "^[a-zA-Z][a-zA-Z0-9_]*$"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"type": "string",
"const": "llm_provider"
},
"timeoutMs": {
"type": "integer",
"maximum": 60000,
"minimum": 100
},
"outputName": {
"type": "string",
"pattern": "^[a-zA-Z][a-zA-Z0-9_]*$"
},
"temperature": {
"type": "number",
"maximum": 2,
"minimum": 0
},
"promptTemplate": {
"type": "string",
"minLength": 1
},
"responseFormat": {
"type": "object",
"properties": {
"type": {
"enum": [
"text",
"json"
],
"type": "string"
},
"schema": {}
},
"additionalProperties": false
},
"maxOutputTokens": {
"type": "integer",
"maximum": 1000000,
"minimum": 1
},
"systemPromptTemplate": {
"type": "string"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"type": "string",
"const": "transform"
},
"source": {
"type": "string",
"minLength": 1
},
"operations": {
"type": "array",
"items": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"minItems": 1
},
"outputName": {
"type": "string",
"pattern": "^[a-zA-Z][a-zA-Z0-9_]*$"
},
"maxOutputItems": {
"type": "integer",
"maximum": 100000,
"minimum": 1
}
},
"additionalProperties": false
}
]
},
"apiId": {
"type": "string",
"minLength": 1
},
"stepId": {
"type": "string",
"minLength": 1
},
"endpointId": {
"type": "string",
"minLength": 1
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"annotations": {
"readOnlyHint": false,
"openWorldHint": false,
"destructiveHint": true
}
}Delete a structured step from an API draft endpoint.
| Parameter | Type | Description |
|---|---|---|
| apiId * | string | |
| stepId * | string | |
| endpointId * | string |
{
"name": "step_delete",
"title": "Delete endpoint step",
"description": "Delete a structured step from an API draft endpoint.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"endpointId",
"stepId",
"apiId"
],
"properties": {
"apiId": {
"type": "string",
"minLength": 1
},
"stepId": {
"type": "string",
"minLength": 1
},
"endpointId": {
"type": "string",
"minLength": 1
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"annotations": {
"readOnlyHint": false,
"openWorldHint": false,
"destructiveHint": true
}
}Set the order of all steps in an API draft endpoint using stable step IDs.
| Parameter | Type | Description |
|---|---|---|
| apiId * | string | |
| stepIds * | array | |
| endpointId * | string |
{
"name": "step_reorder",
"title": "Reorder endpoint steps",
"description": "Set the order of all steps in an API draft endpoint using stable step IDs.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"endpointId",
"stepIds",
"apiId"
],
"properties": {
"apiId": {
"type": "string",
"minLength": 1
},
"stepIds": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
},
"minItems": 1
},
"endpointId": {
"type": "string",
"minLength": 1
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"annotations": {
"readOnlyHint": false,
"openWorldHint": false,
"destructiveHint": true
}
}List metadata for secrets in the authenticated caller workspace.
No parameters.
{
"name": "secret_list",
"title": "List secrets",
"description": "List metadata for secrets in the authenticated caller workspace.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"result"
],
"properties": {
"result": {
"type": "array",
"items": {
"type": "object",
"required": [
"name",
"description",
"updatedAt",
"status",
"environments"
],
"properties": {
"name": {
"type": "string"
},
"status": {
"enum": [
"active",
"partial",
"disabled"
],
"type": "string"
},
"updatedAt": {
"type": "string"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"environments": {
"type": "object",
"required": [
"dev",
"test",
"prod"
],
"properties": {
"dev": {
"type": "object",
"required": [
"status",
"updatedAt"
],
"properties": {
"status": {
"enum": [
"set",
"missing",
"disabled"
],
"type": "string"
},
"updatedAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
"prod": {
"type": "object",
"required": [
"status",
"updatedAt"
],
"properties": {
"status": {
"enum": [
"set",
"missing",
"disabled"
],
"type": "string"
},
"updatedAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
"test": {
"type": "object",
"required": [
"status",
"updatedAt"
],
"properties": {
"status": {
"enum": [
"set",
"missing",
"disabled"
],
"type": "string"
},
"updatedAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}
}
},
"annotations": {
"readOnlyHint": true,
"openWorldHint": false,
"destructiveHint": false
}
}Create a workspace secret. Submitted values are never returned.
| Parameter | Type | Description |
|---|---|---|
| name * | string | |
| values * | object | |
| description | any |
{
"name": "secret_create",
"title": "Create secret",
"description": "Create a workspace secret. Submitted values are never returned.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"name",
"values"
],
"properties": {
"name": {
"type": "string",
"minLength": 1
},
"values": {
"type": "object",
"properties": {
"dev": {
"type": "string",
"maxLength": 16384,
"minLength": 1
},
"prod": {
"type": "string",
"maxLength": 16384,
"minLength": 1
},
"test": {
"type": "string",
"maxLength": 16384,
"minLength": 1
}
},
"additionalProperties": false
},
"description": {
"anyOf": [
{
"type": "string",
"maxLength": 500
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"name",
"description",
"updatedAt",
"status",
"environments"
],
"properties": {
"name": {
"type": "string"
},
"status": {
"enum": [
"active",
"partial",
"disabled"
],
"type": "string"
},
"updatedAt": {
"type": "string"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"environments": {
"type": "object",
"required": [
"dev",
"test",
"prod"
],
"properties": {
"dev": {
"type": "object",
"required": [
"status",
"updatedAt"
],
"properties": {
"status": {
"enum": [
"set",
"missing",
"disabled"
],
"type": "string"
},
"updatedAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
"prod": {
"type": "object",
"required": [
"status",
"updatedAt"
],
"properties": {
"status": {
"enum": [
"set",
"missing",
"disabled"
],
"type": "string"
},
"updatedAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
"test": {
"type": "object",
"required": [
"status",
"updatedAt"
],
"properties": {
"status": {
"enum": [
"set",
"missing",
"disabled"
],
"type": "string"
},
"updatedAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"annotations": {
"readOnlyHint": false,
"openWorldHint": false,
"destructiveHint": false
}
}Rotate one workspace secret. Submitted values are never returned.
| Parameter | Type | Description |
|---|---|---|
| name * | string | |
| values * | object |
{
"name": "secret_rotate",
"title": "Rotate secret",
"description": "Rotate one workspace secret. Submitted values are never returned.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"name",
"values"
],
"properties": {
"name": {
"type": "string",
"minLength": 1
},
"values": {
"type": "object",
"properties": {
"dev": {
"type": "string",
"maxLength": 16384,
"minLength": 1
},
"prod": {
"type": "string",
"maxLength": 16384,
"minLength": 1
},
"test": {
"type": "string",
"maxLength": 16384,
"minLength": 1
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"name",
"description",
"updatedAt",
"status",
"environments"
],
"properties": {
"name": {
"type": "string"
},
"status": {
"enum": [
"active",
"partial",
"disabled"
],
"type": "string"
},
"updatedAt": {
"type": "string"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"environments": {
"type": "object",
"required": [
"dev",
"test",
"prod"
],
"properties": {
"dev": {
"type": "object",
"required": [
"status",
"updatedAt"
],
"properties": {
"status": {
"enum": [
"set",
"missing",
"disabled"
],
"type": "string"
},
"updatedAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
"prod": {
"type": "object",
"required": [
"status",
"updatedAt"
],
"properties": {
"status": {
"enum": [
"set",
"missing",
"disabled"
],
"type": "string"
},
"updatedAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
"test": {
"type": "object",
"required": [
"status",
"updatedAt"
],
"properties": {
"status": {
"enum": [
"set",
"missing",
"disabled"
],
"type": "string"
},
"updatedAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"annotations": {
"readOnlyHint": false,
"openWorldHint": false,
"destructiveHint": true
}
}Deactivate one workspace secret without exposing its values.
| Parameter | Type | Description |
|---|---|---|
| name * | string |
{
"name": "secret_deactivate",
"title": "Deactivate secret",
"description": "Deactivate one workspace secret without exposing its values.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"minLength": 1
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"result"
],
"properties": {
"result": {
"type": "array",
"items": {
"type": "object",
"required": [
"name",
"description",
"updatedAt",
"status",
"environments"
],
"properties": {
"name": {
"type": "string"
},
"status": {
"enum": [
"active",
"partial",
"disabled"
],
"type": "string"
},
"updatedAt": {
"type": "string"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"environments": {
"type": "object",
"required": [
"dev",
"test",
"prod"
],
"properties": {
"dev": {
"type": "object",
"required": [
"status",
"updatedAt"
],
"properties": {
"status": {
"enum": [
"set",
"missing",
"disabled"
],
"type": "string"
},
"updatedAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
"prod": {
"type": "object",
"required": [
"status",
"updatedAt"
],
"properties": {
"status": {
"enum": [
"set",
"missing",
"disabled"
],
"type": "string"
},
"updatedAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
"test": {
"type": "object",
"required": [
"status",
"updatedAt"
],
"properties": {
"status": {
"enum": [
"set",
"missing",
"disabled"
],
"type": "string"
},
"updatedAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}
}
},
"annotations": {
"readOnlyHint": false,
"openWorldHint": false,
"destructiveHint": true
}
}List safe metadata for upstream connections in the authorized workspace.
No parameters.
{
"name": "connection_list",
"title": "List connections",
"description": "List safe metadata for upstream connections in the authorized workspace.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"result"
],
"properties": {
"result": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"workspaceId",
"name",
"description",
"runtimeKind",
"baseUrlByEnvironment",
"authProfileIdByEnvironment",
"defaultHeaders",
"createdAt",
"updatedAt"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"createdAt": {
"type": "string"
},
"updatedAt": {
"type": "string"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"runtimeKind": {
"enum": [
"http",
"llm"
],
"type": "string"
},
"workspaceId": {
"type": "string"
},
"defaultHeaders": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "string"
}
},
"baseUrlByEnvironment": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "string"
}
},
"authProfileIdByEnvironment": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"additionalProperties": false
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}
}
},
"annotations": {
"readOnlyHint": true,
"openWorldHint": false,
"destructiveHint": false
}
}Get safe metadata for one upstream connection in the authorized workspace.
| Parameter | Type | Description |
|---|---|---|
| id * | string |
{
"name": "connection_get",
"title": "Get connection",
"description": "Get safe metadata for one upstream connection in the authorized workspace.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"minLength": 1
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"result"
],
"properties": {
"result": {
"anyOf": [
{
"type": "object",
"required": [
"id",
"workspaceId",
"name",
"description",
"runtimeKind",
"baseUrlByEnvironment",
"authProfileIdByEnvironment",
"defaultHeaders",
"createdAt",
"updatedAt"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"createdAt": {
"type": "string"
},
"updatedAt": {
"type": "string"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"runtimeKind": {
"enum": [
"http",
"llm"
],
"type": "string"
},
"workspaceId": {
"type": "string"
},
"defaultHeaders": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "string"
}
},
"baseUrlByEnvironment": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "string"
}
},
"authProfileIdByEnvironment": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"additionalProperties": false
},
{
"type": "null"
}
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}
}
},
"annotations": {
"readOnlyHint": true,
"openWorldHint": false,
"destructiveHint": false
}
}Create an upstream connection using safe configuration and auth-profile references.
| Parameter | Type | Description |
|---|---|---|
| name * | string | |
| description | any | |
| runtimeKind | string | one of ["http","llm"] |
| defaultHeaders | object | |
| baseUrlByEnvironment * | object | |
| authProfileIdByEnvironment * | object | |
| llmProviderConfigIdByEnvironment | object |
{
"name": "connection_create",
"title": "Create connection",
"description": "Create an upstream connection using safe configuration and auth-profile references.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"name",
"baseUrlByEnvironment",
"authProfileIdByEnvironment"
],
"properties": {
"name": {
"type": "string",
"minLength": 1
},
"description": {
"anyOf": [
{
"type": "string",
"maxLength": 500
},
{
"type": "null"
}
]
},
"runtimeKind": {
"enum": [
"http",
"llm"
],
"type": "string",
"default": "http"
},
"defaultHeaders": {
"type": "object",
"default": {},
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "string"
}
},
"baseUrlByEnvironment": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "string"
}
},
"authProfileIdByEnvironment": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"llmProviderConfigIdByEnvironment": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id",
"workspaceId",
"name",
"description",
"runtimeKind",
"baseUrlByEnvironment",
"authProfileIdByEnvironment",
"defaultHeaders",
"createdAt",
"updatedAt"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"createdAt": {
"type": "string"
},
"updatedAt": {
"type": "string"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"runtimeKind": {
"enum": [
"http",
"llm"
],
"type": "string"
},
"workspaceId": {
"type": "string"
},
"defaultHeaders": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "string"
}
},
"baseUrlByEnvironment": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "string"
}
},
"authProfileIdByEnvironment": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"additionalProperties": false
},
"annotations": {
"readOnlyHint": false,
"openWorldHint": false,
"destructiveHint": false
}
}Update an upstream connection using safe configuration and auth-profile references.
| Parameter | Type | Description |
|---|---|---|
| id * | string | |
| name * | string | |
| description | any | |
| runtimeKind | string | one of ["http","llm"] |
| defaultHeaders | object | |
| baseUrlByEnvironment * | object | |
| authProfileIdByEnvironment * | object | |
| llmProviderConfigIdByEnvironment | object |
{
"name": "connection_update",
"title": "Update connection",
"description": "Update an upstream connection using safe configuration and auth-profile references.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"name",
"baseUrlByEnvironment",
"authProfileIdByEnvironment",
"id"
],
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"name": {
"type": "string",
"minLength": 1
},
"description": {
"anyOf": [
{
"type": "string",
"maxLength": 500
},
{
"type": "null"
}
]
},
"runtimeKind": {
"enum": [
"http",
"llm"
],
"type": "string",
"default": "http"
},
"defaultHeaders": {
"type": "object",
"default": {},
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "string"
}
},
"baseUrlByEnvironment": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "string"
}
},
"authProfileIdByEnvironment": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"llmProviderConfigIdByEnvironment": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id",
"workspaceId",
"name",
"description",
"runtimeKind",
"baseUrlByEnvironment",
"authProfileIdByEnvironment",
"defaultHeaders",
"createdAt",
"updatedAt"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"createdAt": {
"type": "string"
},
"updatedAt": {
"type": "string"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"runtimeKind": {
"enum": [
"http",
"llm"
],
"type": "string"
},
"workspaceId": {
"type": "string"
},
"defaultHeaders": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "string"
}
},
"baseUrlByEnvironment": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "string"
}
},
"authProfileIdByEnvironment": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"additionalProperties": false
},
"annotations": {
"readOnlyHint": false,
"openWorldHint": false,
"destructiveHint": true
}
}List deployment environments and their states for an API.
| Parameter | Type | Description |
|---|---|---|
| apiId * | string |
{
"name": "deployment_list",
"title": "List deployments",
"description": "List deployment environments and their states for an API.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"apiId"
],
"properties": {
"apiId": {
"type": "string",
"minLength": 1
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"result"
],
"properties": {
"result": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"name",
"status",
"activeVersion",
"deployability"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"enum": [
"dev",
"test",
"prod"
],
"type": "string"
},
"status": {
"enum": [
"active",
"disabled"
],
"type": "string"
},
"activeVersion": {
"anyOf": [
{
"type": "object",
"required": [
"id",
"number",
"changelog",
"createdAt"
],
"properties": {
"id": {
"type": "string"
},
"number": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"changelog": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"createdAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
},
"deployability": {
"type": "object",
"required": [
"candidateSource",
"candidateVersion",
"differsFromCurrent",
"eligible",
"reason"
],
"properties": {
"reason": {
"enum": [
"ready",
"project_not_editable",
"environment_disabled",
"draft_missing",
"draft_invalid",
"no_changes",
"source_environment_empty",
"already_current"
],
"type": "string"
},
"eligible": {
"type": "boolean"
},
"candidateSource": {
"enum": [
"draft",
"dev",
"test",
"none"
],
"type": "string"
},
"candidateVersion": {
"anyOf": [
{
"type": "object",
"required": [
"id",
"number",
"changelog",
"createdAt"
],
"properties": {
"id": {
"type": "string"
},
"number": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"changelog": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"createdAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
},
"differsFromCurrent": {
"type": "boolean"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}
}
},
"annotations": {
"readOnlyHint": true,
"openWorldHint": false,
"destructiveHint": false
}
}Get full deployment state including environments and rollback targets for an API.
| Parameter | Type | Description |
|---|---|---|
| apiId * | string |
{
"name": "deployment_get_state",
"title": "Get deployment state",
"description": "Get full deployment state including environments and rollback targets for an API.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"apiId"
],
"properties": {
"apiId": {
"type": "string",
"minLength": 1
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"environments",
"rollbackTargets"
],
"properties": {
"environments": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"name",
"status",
"activeVersion",
"deployability"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"enum": [
"dev",
"test",
"prod"
],
"type": "string"
},
"status": {
"enum": [
"active",
"disabled"
],
"type": "string"
},
"activeVersion": {
"anyOf": [
{
"type": "object",
"required": [
"id",
"number",
"changelog",
"createdAt"
],
"properties": {
"id": {
"type": "string"
},
"number": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"changelog": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"createdAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
},
"deployability": {
"type": "object",
"required": [
"candidateSource",
"candidateVersion",
"differsFromCurrent",
"eligible",
"reason"
],
"properties": {
"reason": {
"enum": [
"ready",
"project_not_editable",
"environment_disabled",
"draft_missing",
"draft_invalid",
"no_changes",
"source_environment_empty",
"already_current"
],
"type": "string"
},
"eligible": {
"type": "boolean"
},
"candidateSource": {
"enum": [
"draft",
"dev",
"test",
"none"
],
"type": "string"
},
"candidateVersion": {
"anyOf": [
{
"type": "object",
"required": [
"id",
"number",
"changelog",
"createdAt"
],
"properties": {
"id": {
"type": "string"
},
"number": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"changelog": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"createdAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
},
"differsFromCurrent": {
"type": "boolean"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"rollbackTargets": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "array",
"items": {
"type": "object",
"required": [
"versionId",
"versionNumber",
"changelog",
"lastDeployedAt"
],
"properties": {
"changelog": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"versionId": {
"type": "string"
},
"versionNumber": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"lastDeployedAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
}
}
}
},
"additionalProperties": false
},
"annotations": {
"readOnlyHint": true,
"openWorldHint": false,
"destructiveHint": false
}
}Deploy the current draft to the Dev environment.
| Parameter | Type | Description |
|---|---|---|
| apiId * | string | |
| changelog | string |
{
"name": "deployment_deploy",
"title": "Deploy API to Dev",
"description": "Deploy the current draft to the Dev environment.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"apiId"
],
"properties": {
"apiId": {
"type": "string",
"minLength": 1
},
"changelog": {
"type": "string"
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"message": {
"type": "string"
},
"skipped": {
"type": "boolean"
},
"versionNumber": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
}
},
"additionalProperties": false
},
"annotations": {
"readOnlyHint": false,
"openWorldHint": false,
"destructiveHint": true
}
}Promote a version from one environment to the next supported environment (Dev to Test, Test to Prod).
No parameters.
{
"name": "deployment_promote",
"title": "Promote deployment",
"description": "Promote a version from one environment to the next supported environment (Dev to Test, Test to Prod).",
"inputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"apiId",
"fromEnvironment",
"toEnvironment"
],
"properties": {
"apiId": {
"type": "string",
"minLength": 1
},
"toEnvironment": {
"type": "string",
"const": "test"
},
"fromEnvironment": {
"type": "string",
"const": "dev"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"apiId",
"fromEnvironment",
"toEnvironment"
],
"properties": {
"apiId": {
"type": "string",
"minLength": 1
},
"toEnvironment": {
"type": "string",
"const": "prod"
},
"fromEnvironment": {
"type": "string",
"const": "test"
}
},
"additionalProperties": false
}
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
},
"outputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"message": {
"type": "string"
},
"versionNumber": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
}
},
"additionalProperties": false
},
"annotations": {
"readOnlyHint": false,
"openWorldHint": false,
"destructiveHint": true
}
}Rollback an environment to a previous version.
| Parameter | Type | Description |
|---|---|---|
| apiId * | string | |
| versionId * | string | |
| environmentName * | string | one of ["dev","test","prod"] |
{
"name": "deployment_rollback",
"title": "Roll back deployment",
"description": "Rollback an environment to a previous version.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"environmentName",
"versionId",
"apiId"
],
"properties": {
"apiId": {
"type": "string",
"minLength": 1
},
"versionId": {
"type": "string",
"minLength": 1
},
"environmentName": {
"enum": [
"dev",
"test",
"prod"
],
"type": "string"
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"versionNumber": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
}
},
"additionalProperties": false
},
"annotations": {
"readOnlyHint": false,
"openWorldHint": false,
"destructiveHint": true
}
}Undeploy an environment, disabling it.
| Parameter | Type | Description |
|---|---|---|
| apiId * | string | |
| environmentName * | string | one of ["dev","test","prod"] |
{
"name": "deployment_undeploy",
"title": "Undeploy API",
"description": "Undeploy an environment, disabling it.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"environmentName",
"apiId"
],
"properties": {
"apiId": {
"type": "string",
"minLength": 1
},
"environmentName": {
"enum": [
"dev",
"test",
"prod"
],
"type": "string"
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"success": {
"type": "boolean"
},
"versionNumber": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
}
},
"additionalProperties": false
},
"annotations": {
"readOnlyHint": false,
"openWorldHint": false,
"destructiveHint": true
}
}List deployment history for an API.
| Parameter | Type | Description |
|---|---|---|
| apiId * | string |
{
"name": "deployment_history",
"title": "List deployment history",
"description": "List deployment history for an API.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"apiId"
],
"properties": {
"apiId": {
"type": "string",
"minLength": 1
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"result"
],
"properties": {
"result": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"kind",
"environmentName",
"versionNumber",
"changelog",
"occurredAt"
],
"properties": {
"id": {
"type": "string"
},
"kind": {
"enum": [
"deploy",
"rollback",
"undeploy"
],
"type": "string"
},
"changelog": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"occurredAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"versionNumber": {
"anyOf": [
{
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
{
"type": "null"
}
]
},
"environmentName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}
}
},
"annotations": {
"readOnlyHint": true,
"openWorldHint": false,
"destructiveHint": false
}
}Names, descriptions and schemas were written by the server and are shown as data.
Shared addresses on big platforms (Cloudflare, Vercel and the like) put unrelated servers together; those are marked shared_infrastructure. A match is a pivot, not a link between operators.