> ## Documentation Index
> Fetch the complete documentation index at: https://docs.prisme.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# List the tools an attached MCP server exposes

> Runs the server's `tools/list` and returns each advertised tool with
the `canonical_name` the model calls it by (the name a
`tool_permissions` rule must target to reach that tool), plus its
`inputSchema` and `annotations` exactly as published. `canonical_name`
is computed by the runtime's own naming helper: consume it, never
derive it.

Always `200` once the entry is resolved. `status` says whether the
list could be fetched (`ok`), whether the caller has to connect to an
OAuth-gated server first (`auth_required`, empty `items`), or whether
the server did not answer (`unavailable`, empty `items`, `error`).
Only `mcp` entries have capabilities: any other type is a `400`. The
list is served from the same per-server cache the runtime uses, with
the same rule: never cached for auth-bearing catalog entries.




## OpenAPI

````yaml /api-reference/agent-factory/swagger.yml get /v1/agents/{agentId}/tools/{toolId}/capabilities
openapi: 3.0.3
info:
  version: 1.0.0
  title: Agent Factory API
  description: |
    Public REST API for the Agent Factory workspace - agents, conversations,
    messages, tools, artifacts, sharing, ratings, and discovery.
    Powered by Prisme.ai's runtime; all endpoints are exposed under each
    workspace's webhook namespace.
  contact:
    name: Prisme.ai
    url: https://prisme.ai
servers:
  - url: https://{host}/v2/workspaces/slug:agent-factory/webhooks
    description: Prisme.ai workspace webhooks
    variables:
      host:
        default: api.studio.prisme.ai
        description: API host (override for self-hosted or sandbox)
security:
  - BearerAuth: []
  - OrgApiKeyAuth: []
tags:
  - name: Agents
    description: Agent CRUD, discovery, AGENTS.md import/export.
  - name: Access
    description: Agent access bindings, sharing, and access requests.
  - name: ApiKeys
    description: Agent-scoped API key management (mint, revoke, rotate).
  - name: Publishing
    description: Publish or discard draft changes on an agent.
  - name: Ratings
    description: User ratings on published agents.
  - name: Profiles
    description: >-
      Agent profiles/presets catalog (simple, workflow, agent_light, agent_full,
      orchestrator).
  - name: Activity
    description: Activity feed for agents (events, errors, lifecycle changes).
  - name: Analytics
    description: Agent usage analytics (series + summary).
  - name: Conversations
    description: Conversations on an agent (CRUD, archive, star).
  - name: Messages
    description: Send messages to an agent (synchronous send + SSE stream).
  - name: Tasks
    description: Async task lifecycle (list, fetch, cancel, resolve, subscribe).
  - name: Artifacts
    description: Generated artifacts (files, code, content) attached to a task.
  - name: Shares
    description: Conversation, message, and artifact share-link snapshots.
  - name: A2A
    description: Agent-to-agent JSON-RPC 2.0 gateway (well-known agent.json + RPC).
  - name: Tools
    description: Per-agent tool catalogue (system tools, MCP servers, function tools).
  - name: Retention
    description: Per-agent and org-wide conversation retention policies.
  - name: Traces
    description: >-
      Execution traces of agent turns (editor debugging,
      `agent-factory:traces:read`).
  - name: Evaluations
    description: Agent evaluation runs and results.
  - name: Admin
    description: |
      GDPR operations called by the AI Insights admin screens. They require
      elevated permissions: the caller must be a platform administrator
      (`platformRole` `superadmin` or `root`). The export route also lets a
      user export their own data. Each route is rate limited to 10 calls per
      hour per caller.
paths:
  /v1/agents/{agentId}/tools/{toolId}/capabilities:
    get:
      tags:
        - Tools
      summary: List the tools an attached MCP server exposes
      description: |
        Runs the server's `tools/list` and returns each advertised tool with
        the `canonical_name` the model calls it by (the name a
        `tool_permissions` rule must target to reach that tool), plus its
        `inputSchema` and `annotations` exactly as published. `canonical_name`
        is computed by the runtime's own naming helper: consume it, never
        derive it.

        Always `200` once the entry is resolved. `status` says whether the
        list could be fetched (`ok`), whether the caller has to connect to an
        OAuth-gated server first (`auth_required`, empty `items`), or whether
        the server did not answer (`unavailable`, empty `items`, `error`).
        Only `mcp` entries have capabilities: any other type is a `400`. The
        list is served from the same per-server cache the runtime uses, with
        the same rule: never cached for auth-bearing catalog entries.
      operationId: getAgentToolCapabilities
      parameters:
        - name: agentId
          in: path
          required: true
          schema:
            type: string
            maxLength: 64
        - name: toolId
          in: path
          required: true
          schema:
            type: string
            maxLength: 128
      responses:
        '200':
          description: Server tools, or the reason they could not be listed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ToolCapabilities'
        '400':
          description: The entry is not an MCP server.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Authentication required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Tool not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '405':
          description: Method not allowed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    ToolCapabilities:
      type: object
      description: |
        Tools an MCP server attached to an agent exposes, as returned by
        `GET /v1/agents/{agentId}/tools/{toolId}/capabilities`.
      required:
        - status
        - items
      properties:
        status:
          type: string
          enum:
            - ok
            - auth_required
            - unavailable
          description: |
            `ok`: `items` is the server's list. `auth_required`: OAuth-gated
            server the caller is not connected to; `items` is empty.
            `unavailable`: the handshake or `tools/list` failed; `items` is
            empty and `error` carries the message.
        items:
          type: array
          items:
            $ref: '#/components/schemas/ServerTool'
        error:
          type: string
          description: Transport or JSON-RPC error message when `status` is `unavailable`.
    Error:
      type: object
      required:
        - error
        - message
      properties:
        error:
          type: string
          description: >-
            Stable PascalCase or SNAKE_CASE error code (e.g. AgentNotFound,
            VALIDATION_ERROR, FORBIDDEN, METHOD_NOT_ALLOWED).
        message:
          type: string
          description: Human-readable error message.
        details:
          type: object
          description: Optional structured context for the error.
          additionalProperties: true
    ServerTool:
      type: object
      description: |
        One tool advertised by an MCP server (`tools/list`), with the name the
        runtime exposes it under.
      required:
        - name
        - canonical_name
      properties:
        name:
          type: string
          description: >-
            Tool name exactly as the server advertises it (what `tools/call`
            receives).
        canonical_name:
          type: string
          pattern: ^[a-zA-Z0-9_-]{1,64}$
          description: |
            `<parent>__<child>` name the model calls the tool by, and the value
            a `tool_permissions.tools[].tool` rule must carry to target this
            tool. Both segments sanitised to `[A-Za-z0-9_-]`, the pair trimmed
            to 64 characters. Computed by the runtime; never derive it.
        description:
          type: string
        inputSchema:
          type: object
          additionalProperties: true
          description: |
            JSON Schema of the tool's arguments, as published. A
            `properties.action.enum` is the Prisme schema convention for
            several operations behind one tool; a rule may target one of them
            with `conditions: {action: "<value>"}`.
        annotations:
          type: object
          nullable: true
          additionalProperties: true
          description: |
            MCP tool annotations as published (`readOnlyHint`,
            `destructiveHint`, …), `null` when the server publishes none.
            Forwarded raw; nothing is derived from them.
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: |
        User-bound credential carrying an identity: either a session JWT
        or a user access token (`at:*`) generated from the user settings UI.
        Send as `Authorization: Bearer <token>`.
        Org API keys (`iak_*`) are **not** accepted here - they carry
        no user identity. Use the `x-prismeai-api-key` header instead
        (see `OrgApiKeyAuth`).
    OrgApiKeyAuth:
      type: apiKey
      in: header
      name: x-prismeai-api-key
      description: |
        Organization API key (`iak_{orgSlug}_{uuid}`). Unlike
        `Authorization: Bearer`, this credential is **not** tied to a user
        identity - it is bound to the org and its effective access is
        defined by the scopes / permission rules attached to it (it can
        be restricted to a single project, or kept broader).
        For Agent Factory, these keys can be generated directly from
        the Agent Factory UI (in addition to the AI Governance settings).
        Send as `x-prismeai-api-key: iak_...`.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.