@squidcloud/client
    Preparing search index...

    Interface AiAgentMcpServerConfig

    Configuration for exposing an AI agent as an MCP server at /mcp/<agentId>.

    interface AiAgentMcpServerConfig {
        description?: string;
        enabled: boolean;
        oauthIntegrationId?: string;
        requireApiKey?: boolean;
        toolDescription?: string;
    }
    Index
    description? enabled oauthIntegrationId? requireApiKey? toolDescription?
    description?: string

    Description of the MCP server, served as the instructions field of the MCP initialize result. Defaults to the agent description when not provided.

    enabled: boolean

    Whether the agent is exposed as an MCP server.

    oauthIntegrationId?: string

    ID of an auth integration used to OAuth-protect the MCP server. When set, MCP requests must include a valid bearer token from this integration. Without this and requireApiKey, the MCP endpoint is public.

    requireApiKey?: boolean

    When true, MCP requests must present the agent's API key as a bearer token (Authorization: Bearer <agent API key> or the x-squid-agent-api-key header). Can be combined with oauthIntegrationId, in which case either credential is accepted.

    toolDescription?: string

    Description of the MCP ask tool, exposed in the tools manifest. Defaults to a generic ask-the-agent description when not provided.

    Settings
    Member Visibility

    On This Page
    Properties