API & DEVELOPERS

MCP reference · v1

verify_connection

Save a durable, read-only provider identity check and return its job ID. The AWS worker continues after this chat closes. Requires a service verification grant.

Changes saved state

Company permissions

Required scopes: orchesphere.read, orchesphere.jobs. Current identity, company and service/portal rights are checked for every call. Scopes do not create access.

Provider verify permission, implemented identity adapter and current entitlement/quota. Requires Idempotency-Key; replay with the same workspace/requester/key and connection returns the existing job, possibly already terminal. A different connection conflicts. Equivalent REST operation.

Input schema

FieldTypeRequiredDescription / bounds
workspaceIdstringYesAn assigned company workspace ID.
connectionIdstringYes—
idempotencyKeystringYesUnique request key, reused when retrying this exact submission.
Complete MCP input schema
{
  "type": "object",
  "properties": {
    "workspaceId": {
      "type": "string",
      "description": "An assigned company workspace ID."
    },
    "connectionId": {
      "type": "string"
    },
    "idempotencyKey": {
      "type": "string",
      "description": "Unique request key, reused when retrying this exact submission."
    }
  },
  "required": [
    "workspaceId",
    "connectionId",
    "idempotencyKey"
  ],
  "additionalProperties": false
}

Tool call

json
{
  "jsonrpc": "2.0",
  "id": 2,
  "method": "tools/call",
  "params": {
    "name": "verify_connection",
    "arguments": {
      "workspaceId": "11111111-1111-4111-8111-111111111111",
      "connectionId": "22222222-2222-4222-8222-222222222222",
      "idempotencyKey": "verification_example_001"
    }
  }
}

POST to https://orchesphere.ai/mcp with a Bearer token approved for the MCP resource. Initialize the connection first. Examples use fictional identifiers.

Response handling

A successful tool result includes text content and structuredContent. Inspect isError before treating a tool result as successful. Authentication and scope failures may use HTTP 401/403 with WWW-Authenticate. This tool does not publish a separate MCP output schema; use its returned structure rather than assuming a provider business-record response.

All MCP tools · Errors and retry guidance