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

# Get MCP client setup

> Get the setup for adding an MCP to one client: the command or config, ready to paste.

<Accordion title="Details">
  * Clients: Claude Code, Codex, Cursor, VS Code, Claude Desktop or any MCP client.

  * Without integration\_id, this sets up the Pomerado MCP. With it, that integration's own MCP; one whose MCP is disabled or not hosted is not found, and one not ready yet answers mcp\_not\_ready.

  * The snippet never carries a secret. With oauth, the default, the client signs in itself; with api\_key, it reads the POMERADO\_API\_KEY environment variable.

  * **Callers:** an API key, an integration's API key, an MCP OAuth token or a Dashboard session.

  * **Permission:** `tools:read`.

  * **Effect:** Changes nothing.

  * **Errors:** [`not_found`](/errors#not_found), [`mcp_not_ready`](/errors#mcp_not_ready), [`not_configured`](/errors#not_configured), and the [errors any request can get](/errors).
</Accordion>


## OpenAPI

````yaml /api-reference/openapi.json get /v1/connect
openapi: 3.1.0
info:
  title: Pomerado API
  version: '1'
  description: >-
    Run and build website tools, follow their jobs, and manage logins, API keys
    and webhooks. Authenticate with a Pomerado API key (pom_…), an MCP OAuth
    token or a Dashboard session as a Bearer token.
servers:
  - url: https://api.pomerado.ai
security: []
tags:
  - name: account
    x-group: Account
  - name: api_keys
    x-group: API keys
  - name: connected_apps
    x-group: Connected apps
  - name: usage
    x-group: Usage
  - name: quota
    x-group: Quota
  - name: billing
    x-group: Billing
  - name: integrations
    x-group: Integrations
  - name: connect
    x-group: Connect
  - name: logins
    x-group: Saved logins
  - name: two_factor
    x-group: 2FA
  - name: login_access
    x-group: Login access
  - name: tools
    x-group: Tools
  - name: webhooks
    x-group: Webhooks
  - name: runs
    x-group: Runs
  - name: builds
    x-group: Builds
  - name: jobs
    x-group: Jobs
  - name: files
    x-group: Files
  - name: team
    x-group: Team
paths:
  /v1/connect:
    get:
      tags:
        - connect
      summary: Get MCP client setup
      description: >-
        Get the setup for adding an MCP to one client: the command or config,
        ready to paste.
      operationId: connect.get
      parameters:
        - name: client
          in: query
          required: true
          description: The MCP client to set up; any gives a generic JSON config
          schema:
            type: string
            enum:
              - claude_code
              - codex
              - cursor
              - vscode
              - claude_desktop
              - any
        - name: integration_id
          in: query
          required: false
          description: The integration whose MCP to connect; omit it for the Pomerado MCP
          schema:
            type: string
            examples:
              - int_0f8e2d1c4b3a49e8a7f6e5d4c3b2a190
        - name: auth
          in: query
          required: false
          description: >-
            How the client signs in: oauth (the default), or api_key, which
            sends the POMERADO_API_KEY environment variable as a Bearer token.
            Claude Desktop takes oauth only
          schema:
            type: string
            enum:
              - oauth
              - api_key
      responses:
        '200':
          description: The client's setup
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Connect'
        '400':
          description: invalid_request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: unauthorized, reauthentication_required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: not_found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: mcp_not_ready
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: internal_error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '501':
          description: not_configured
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '503':
          description: temporarily_unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - bearer: []
components:
  schemas:
    Connect:
      type: object
      required:
        - client
        - name
        - mcp_url
        - keyless_mcp_url
        - transport
        - auth
        - format
        - snippet
        - docs_url
        - api_base_url
        - openapi_url
      properties:
        client:
          type: string
          enum:
            - claude_code
            - codex
            - cursor
            - vscode
            - claude_desktop
            - any
        name:
          type: string
        mcp_url:
          type: string
        keyless_mcp_url:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            The same MCP's URL for use without signing in; null for a private
            integration
        transport:
          type: string
          enum:
            - streamable_http
        auth:
          type: string
          enum:
            - oauth
            - api_key
        format:
          type: string
          enum:
            - shell
            - json
            - text
        snippet:
          type: string
          description: What to paste or run, as format says
        docs_url:
          type: string
        api_base_url:
          type: string
          description: The REST API's base URL, such as https://api.pomerado.ai/v1
        openapi_url:
          type: string
          description: >-
            The OpenAPI document for what this MCP reaches: the Pomerado API or
            the integration
      additionalProperties: false
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
            - retryable
            - docs_url
          properties:
            code:
              type: string
            message:
              type: string
            retryable:
              type: boolean
            docs_url:
              type: string
            details:
              type: object
              required: []
              properties: {}
              additionalProperties:
                $id: /schemas/unknown
          additionalProperties: false
      additionalProperties: false
  securitySchemes:
    bearer:
      type: http
      scheme: bearer

````

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