Identity and built-in docs

Inspect the connected identity and read the platform guides bundled with the server.

Inspect the connected identity and read the platform guides bundled with the server.

These are action names. In default compact mode, call the indicated group tool with {"action":"<action-name>","params":{...}}; the arguments below go inside params. In ?mode=all, call the action name directly with those arguments. browse_github and read_docs are direct tools in both modes. Expand each schema for nested fields, enum values and validation constraints. Successful results are JSON in both text content and structuredContent; failures use isError and structuredContent.error.

whoami

Identify the caller: account, credential and permissions. The credential is an API key or a connected app

Group: account · Behavior: Read

Compact tool: account · Action: whoami

MCP annotations: readOnlyHint: true · destructiveHint: false · idempotentHint: true · openWorldHint: false

Permissions and REST equivalents

Operation	REST	Required scopes
auth.whoami	GET /me	Authenticated connection; organization and resource permissions still apply

Arguments

No arguments. Send an empty object.

Complete input schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Result

• user (object): See the complete response schema below.

• limitedToOrgs (array<object> or null): The organizations the key or connection is limited to; null when it reaches every one the user is in, including ones they join later (orgs.list has them, with the user's role in each)

• apiKey (object or null): The key in use, or null when the caller is not using an API key

• oauthClient (object or null): The app connected through OAuth (hosted chat connectors), or null

Response schema: auth.whoami

{
  "type": "object",
  "properties": {
    "user": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "email": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "email",
        "name"
      ],
      "additionalProperties": false
    },
    "limitedToOrgs": {
      "anyOf": [
        {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "slug": {
                "type": "string"
              },
              "name": {
                "type": "string"
              }
            },
            "required": [
              "id",
              "slug",
              "name"
            ],
            "additionalProperties": false
          }
        },
        {
          "type": "null"
        }
      ],
      "description": "The organizations the key or connection is limited to; null when it reaches every one the user is in, including ones they join later (orgs.list has them, with the user's role in each)"
    },
    "apiKey": {
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "id": {
              "type": "string"
            },
            "name": {
              "type": "string"
            },
            "scopes": {
              "type": "array",
              "items": {
                "type": "string"
              },
              "description": "Granted permissions; [\"*\"] is full access, including permissions added to the API later"
            },
            "projectIds": {
              "type": "array",
              "items": {
                "type": "string"
              },
              "description": "Projects the key is limited to; empty means every project"
            }
          },
          "required": [
            "id",
            "name",
            "scopes",
            "projectIds"
          ],
          "additionalProperties": false
        },
        {
          "type": "null"
        }
      ],
      "description": "The key in use, or null when the caller is not using an API key"
    },
    "oauthClient": {
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "grantId": {
              "type": "string",
              "description": "The connection as listed in the dashboard's connected apps"
            },
            "clientId": {
              "type": "string"
            },
            "clientName": {
              "type": "string"
            },
            "scopes": {
              "type": "array",
              "items": {
                "type": "string"
              },
              "description": "Permissions this connection was authorized with"
            }
          },
          "required": [
            "grantId",
            "clientId",
            "clientName",
            "scopes"
          ],
          "additionalProperties": false
        },
        {
          "type": "null"
        }
      ],
      "description": "The app connected through OAuth (hosted chat connectors), or null"
    }
  },
  "required": [
    "user",
    "limitedToOrgs",
    "apiKey",
    "oauthClient"
  ],
  "additionalProperties": false
}

read_docs

The platform guide for agents, by topic; the topic list says what each covers. Read it before an unfamiliar task.

Group: docs · Behavior: Read

Compact tool: read_docs (direct call)

MCP annotations: readOnlyHint: true · destructiveHint: false · idempotentHint: true · openWorldHint: false

Permissions and REST equivalents

Operation	REST	Required scopes
docs.get	GET /docs/{topic}	Authenticated connection; organization and resource permissions still apply

Arguments

Argument	Type	Required	Description
topic	"getting_started" / "deploy" / "operate" / "troubleshoot" / "servers" / "billing" / "organizations" / "sharing" / "errors"	Yes	getting_started (concepts, ids, permissions), deploy (create_app fields), operate (updates, lifecycle, logs), troubleshoot (states and failures), servers (catalog, provisioning, grids), sharing (grantees, invitations), billing, errors (every code)

Complete input schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "topic": {
      "type": "string",
      "enum": [
        "getting_started",
        "deploy",
        "operate",
        "troubleshoot",
        "servers",
        "billing",
        "organizations",
        "sharing",
        "errors"
      ],
      "description": "getting_started (concepts, ids, permissions), deploy (create_app fields), operate (updates, lifecycle, logs), troubleshoot (states and failures), servers (catalog, provisioning, grids), sharing (grantees, invitations), billing, errors (every code)"
    }
  },
  "required": [
    "topic"
  ],
  "additionalProperties": false
}

Result

• topic ("getting_started" / "deploy" / "operate" / "troubleshoot" / "servers" / "billing" / "organizations" / "sharing" / "errors"): getting_started (concepts, ids, permissions), deploy (create_app fields), operate (updates, lifecycle, logs), troubleshoot (states and failures), servers (catalog, provisioning, grids), sharing (grantees, invitations), billing, errors (every code)

• title (string): See the complete response schema below.

• markdown (string): The guide text, in markdown

Response schema: docs.get

{
  "type": "object",
  "properties": {
    "topic": {
      "type": "string",
      "enum": [
        "getting_started",
        "deploy",
        "operate",
        "troubleshoot",
        "servers",
        "billing",
        "organizations",
        "sharing",
        "errors"
      ],
      "description": "getting_started (concepts, ids, permissions), deploy (create_app fields), operate (updates, lifecycle, logs), troubleshoot (states and failures), servers (catalog, provisioning, grids), sharing (grantees, invitations), billing, errors (every code)"
    },
    "title": {
      "type": "string"
    },
    "markdown": {
      "type": "string",
      "description": "The guide text, in markdown"
    }
  },
  "required": [
    "topic",
    "title",
    "markdown"
  ],
  "additionalProperties": false
}