API & DEVELOPERS

MCP reference · v1

configure_connection

Register or replace this company’s provider configuration. Use an AWS credential reference, never a secret. This does not establish live provider access.

Changes saved state Can replace or revoke state

Company permissions

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

Provider configure permission; browser_session also requires company owner. Allowed mode depends on catalog provider. Production entitlements/limits apply. Uses a credential reference only; changing settings invalidates previous evidence. Equivalent REST operation.

Input schema

FieldTypeRequiredDescription / bounds
workspaceIdstringYesAn assigned company workspace ID.
providerstringYes—
environment"production" | "sandbox"Yes—
expectedAccountIdstringYes—
expectedCompanyNamestringYes—
authMode"secrets_manager" | "agentcore" | "browser_session"Yes—
credentialRefstringNomaxLength: 512
Complete MCP input schema
{
  "type": "object",
  "properties": {
    "workspaceId": {
      "type": "string",
      "description": "An assigned company workspace ID."
    },
    "provider": {
      "type": "string"
    },
    "environment": {
      "type": "string",
      "enum": [
        "production",
        "sandbox"
      ]
    },
    "expectedAccountId": {
      "type": "string"
    },
    "expectedCompanyName": {
      "type": "string"
    },
    "authMode": {
      "type": "string",
      "enum": [
        "secrets_manager",
        "agentcore",
        "browser_session"
      ]
    },
    "credentialRef": {
      "type": "string",
      "maxLength": 512
    }
  },
  "required": [
    "workspaceId",
    "provider",
    "environment",
    "expectedAccountId",
    "expectedCompanyName",
    "authMode"
  ],
  "additionalProperties": false
}

Tool call

json
{
  "jsonrpc": "2.0",
  "id": 2,
  "method": "tools/call",
  "params": {
    "name": "configure_connection",
    "arguments": {
      "workspaceId": "11111111-1111-4111-8111-111111111111",
      "provider": "stripe",
      "environment": "production",
      "expectedAccountId": "example-account",
      "expectedCompanyName": "Example Company",
      "authMode": "secrets_manager"
    }
  }
}

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