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

# Register an MCP server for an agent

> Register a Model Context Protocol (MCP) server so the agent can discover and call the tools it exposes. Supply a `name`, an `https://` `server_url`, and `server_type: http_sse`, optionally with a static bearer credential or an OAuth2 grant (mutually exclusive) and a `tool_allowlist` that scopes which tools are exposed. The URL is SSRF-validated and any credentials are encrypted at rest. Requires an operator role (owner, admin, or developer).



## OpenAPI

````yaml /openapi.yaml post /api/v1/agents/{agentId}/mcp-servers
openapi: 3.1.0
info:
  title: Devotel CPaaS API
  description: Orbit by Devotel — Communications Platform as a Service API
  version: 1.0.0
  contact:
    name: Devotel
    url: https://devotel.io
    email: support@devotel.io
  license:
    name: Proprietary
servers:
  - url: https://api.orbit.devotel.io
    description: Production
security:
  - Bearer: []
  - ApiKey: []
tags:
  - name: Messages
    description: >-
      Send and manage messages across all channels (SMS, WhatsApp, RCS, Email,
      Viber, etc.)
  - name: Fax
    description: >-
      List and track fax (MMS/T.38) transmissions on Telnyx-backed fax numbers
      (sending flows through the Messaging API)
  - name: Agents
    description: AI agent creation, configuration, and execution
  - name: Voice
    description: Voice calls, IVR, conferencing, and SIP trunking
  - name: OnCall
    description: On-call rotations and escalation policy planning for incident alerting
  - name: Webhooks
    description: Webhook endpoint management and delivery logs
  - name: Numbers
    description: Phone number search, provisioning, and configuration
  - name: Brand Identity
    description: >-
      Unified cross-channel brand trust posture (10DLC, toll-free, WhatsApp,
      RCS, branded calling, number KYC)
  - name: Contacts
    description: Contact management, segmentation, and lifecycle tracking
  - name: Campaigns
    description: Marketing campaign orchestration and analytics
  - name: Flows
    description: Automation flow builder and execution engine
  - name: Templates
    description: Message template management and approval workflows
  - name: Settings
    description: Organization, channel, and user preference settings
  - name: Verify
    description: OTP generation and verification across channels
  - name: Push
    description: Push notification delivery via FCM and APNs
  - name: Integrations
    description: Third-party service connections and OAuth management
  - name: CDP
    description: >-
      Customer Data Platform — activation surface (CRM object sync, streaming
      destinations, ad-audience activation)
  - name: Files
    description: >-
      Server-to-server media upload, listing, retrieval, and deletion
      (signed-URL backed)
  - name: Commerce
    description: >-
      Omnichannel conversational-commerce — persistent cart + checkout state
      machine, channel-agnostic hosted pay-by-link, native WhatsApp checkout,
      and AP2-style agent payment mandates.
  - name: Sync
    description: >-
      Real-time shared-state primitive (Twilio Sync parity) — Documents, Maps,
      Lists, and ephemeral Streams, with change events relayed over the
      /api/v1/ws/sync WebSocket gateway
paths:
  /api/v1/agents/{agentId}/mcp-servers:
    post:
      tags:
        - Agents
      summary: Register an MCP server for an agent
      description: >-
        Register a Model Context Protocol (MCP) server so the agent can discover
        and call the tools it exposes. Supply a `name`, an `https://`
        `server_url`, and `server_type: http_sse`, optionally with a static
        bearer credential or an OAuth2 grant (mutually exclusive) and a
        `tool_allowlist` that scopes which tools are exposed. The URL is
        SSRF-validated and any credentials are encrypted at rest. Requires an
        operator role (owner, admin, or developer).
      parameters:
        - schema:
            type: string
          in: path
          name: agentId
          required: true
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - name
                - server_url
                - server_type
              properties:
                name:
                  type: string
                  minLength: 1
                  maxLength: 120
                  description: Human-readable label, unique per agent.
                server_url:
                  type: string
                  maxLength: 2048
                  description: HTTPS URL of the MCP server (SSE transport).
                server_type:
                  type: string
                  enum:
                    - http_sse
                  description: Transport type; only http_sse is supported.
                auth_credentials:
                  type: string
                  maxLength: 8192
                  description: >-
                    Optional static bearer token / API key, stored encrypted.
                    Mutually exclusive with oauth2.
                tool_allowlist:
                  type: array
                  items:
                    type: string
                  description: >-
                    Optional allowlist of tool names to expose. Absent = expose
                    all; [] = expose none.
                metadata:
                  type: object
                  additionalProperties: true
                  description: Optional free-form metadata.
                enabled:
                  type: boolean
                  description: Whether the server is active. Defaults to true.
            example:
              name: Acme Tools
              server_url: https://mcp.acme.example.com/sse
              server_type: http_sse
              tool_allowlist:
                - create_ticket
                - lookup_order
      responses:
        '201':
          description: The MCP server was registered.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                      organization_id:
                        type: string
                      agent_id:
                        type: string
                      name:
                        type: string
                      server_url:
                        type: string
                      server_type:
                        type: string
                      metadata:
                        type: object
                        additionalProperties: true
                      enabled:
                        type: boolean
                      has_auth_credentials:
                        type: boolean
                      auth_type:
                        type: string
                        enum:
                          - oauth2
                          - bearer
                          - none
                      tool_allowlist:
                        type: array
                        items:
                          type: string
                        nullable: true
                  meta:
                    $ref: '#/components/schemas/ResponseMeta'
components:
  schemas:
    ResponseMeta:
      type: object
      required:
        - request_id
        - timestamp
      additionalProperties: false
      properties:
        request_id:
          type: string
          description: Unique request identifier (also returned as X-Request-Id header)
        timestamp:
          type: string
          format: date-time
        docs_url:
          type: string
          format: uri
          nullable: true
  securitySchemes:
    Bearer:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Dashboard JWT token from Clerk
    ApiKey:
      type: apiKey
      name: X-API-Key
      in: header
      description: Server-to-server API key (dv_live_sk_*)

````