API & DEVELOPERS

MCP reference · v1

set_platform_role

Revoke an existing platform authority assignment using a platform-admin-controlled internal OAuth binding. Global authority cannot be created or transferred through the application. The last active platform administrator cannot be removed.

Changes saved state Can replace or revoke state

Company permissions

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

Input schema

FieldTypeRequiredDescription / bounds
workspaceIdstringYesAn assigned company workspace ID.
emailstringYes—
role"none"Yes—
Complete MCP input schema
{
  "type": "object",
  "properties": {
    "workspaceId": {
      "type": "string",
      "description": "An assigned company workspace ID."
    },
    "email": {
      "type": "string"
    },
    "role": {
      "type": "string",
      "enum": [
        "none"
      ]
    }
  },
  "required": [
    "workspaceId",
    "email",
    "role"
  ],
  "additionalProperties": false
}

Tool call

json
{
  "jsonrpc": "2.0",
  "id": 2,
  "method": "tools/call",
  "params": {
    "name": "set_platform_role",
    "arguments": {
      "workspaceId": "11111111-1111-4111-8111-111111111111",
      "email": "member@example.com",
      "role": "none"
    }
  }
}

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