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

# Install a local MCP server for the organization

> Installs a local MCP catalog entry for the organization; requires an organization admin. `catalog_id` is the entry's id from `list_mcp_server_directory` (or `get_mcp_server_directory_entry`), whose `configuration_schema` says which `configuration` keys are required. Configuration holds non-secret settings only; never put a credential in it. `availability` is `opt_in` (users connect it themselves) or `required` (every CLI in the organization gets it). Set its policy separately.



## OpenAPI

````yaml /api-reference/openapi.yaml post /api/registry/v1/local-providers/installations
openapi: 3.1.0
info:
  title: Barndoor.ai Public API
  description: Unified public API specification for Barndoor.ai platform
  version: 2.38.0
servers:
  - url: https://{host}
    description: Barndoor public API
    variables:
      host:
        default: platform.barndoor.ai
        description: >-
          The host serving your Barndoor deployment. Defaults to production;
          override it for another environment or a dedicated deployment.
security:
  - ApiKey: []
  - OAuth2:
      - openid
      - profile
      - email
tags:
  - name: dlp
    x-group: Data Control Center
  - name: identity
    x-group: Identity
  - name: llm-gateway
    x-group: LLM Gateway
  - name: notification
    x-group: Notifications
  - name: policy
    x-group: Policies
  - name: registry
    x-group: MCP Gateway
  - name: system-management
    x-group: Log Exports
paths:
  /api/registry/v1/local-providers/installations:
    post:
      tags:
        - registry
      summary: Install a local MCP server for the organization
      description: >-
        Installs a local MCP catalog entry for the organization; requires an
        organization admin. `catalog_id` is the entry's id from
        `list_mcp_server_directory` (or `get_mcp_server_directory_entry`), whose
        `configuration_schema` says which `configuration` keys are required.
        Configuration holds non-secret settings only; never put a credential in
        it. `availability` is `opt_in` (users connect it themselves) or
        `required` (every CLI in the organization gets it). Set its policy
        separately.
      operationId: create_local_mcp_installation
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InstallationCreate'
        required: true
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InstallationRead'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    InstallationCreate:
      properties:
        catalog_id:
          type: string
          format: uuid
          title: Catalog Id
          description: >-
            Id of the local MCP catalog entry to install (its server-directory
            id).
        slug:
          type: string
          pattern: ^[a-z][a-z0-9-]{0,99}$
          title: Slug
          description: >-
            Installation slug, unique in the organization; users see it in
            `barndoor list`.
        name:
          type: string
          maxLength: 255
          minLength: 1
          title: Name
          description: Display name.
        enabled:
          type: boolean
          title: Enabled
          default: true
        configuration:
          additionalProperties:
            $ref: '#/components/schemas/JsonValue'
          type: object
          title: Configuration
          description: >-
            Values for the catalog entry's `configuration_schema`: a flat object
            of scalar values, every required key present and no undeclared key.
            Not for secrets.
        availability:
          type: string
          enum:
            - opt_in
            - required
          title: Availability
          description: >-
            `opt_in`: only users who connect it get it. `required`: every
            Barndoor CLI in the organization gets it.
          default: opt_in
      additionalProperties: false
      type: object
      required:
        - catalog_id
        - slug
        - name
      title: InstallationCreate
    InstallationRead:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        catalog_id:
          type: string
          format: uuid
          title: Catalog Id
        slug:
          type: string
          title: Slug
        name:
          type: string
          title: Name
        enabled:
          type: boolean
          title: Enabled
        configuration:
          additionalProperties:
            $ref: '#/components/schemas/JsonValue'
          type: object
          title: Configuration
        availability:
          type: string
          enum:
            - opt_in
            - required
          title: Availability
        runtime:
          oneOf:
            - $ref: '#/components/schemas/EmbeddedRuntime'
            - $ref: '#/components/schemas/ManagedMcpRuntime'
            - $ref: '#/components/schemas/LocalCliRuntime'
            - $ref: '#/components/schemas/RemoteRuntime'
          title: Runtime
          discriminator:
            propertyName: kind
            mapping:
              embedded: '#/components/schemas/EmbeddedRuntime'
              local_cli: '#/components/schemas/LocalCliRuntime'
              managed_local_mcp: '#/components/schemas/ManagedMcpRuntime'
              remote: '#/components/schemas/RemoteRuntime'
        configuration_schema:
          additionalProperties: true
          type: object
          title: Configuration Schema
      additionalProperties: false
      type: object
      required:
        - id
        - catalog_id
        - slug
        - name
        - enabled
        - configuration
        - availability
        - runtime
        - configuration_schema
      title: InstallationRead
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    JsonValue: {}
    EmbeddedRuntime:
      properties:
        kind:
          type: string
          const: embedded
          title: Kind
          default: embedded
        ref:
          type: string
          pattern: >-
            ^com\.barndoor\.(cli|mcp)\.[a-z][a-z0-9_-]{0,99}$|^com\.barndoor\.tenant\.[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}\.[a-z][a-z0-9_-]{0,99}$
          title: Ref
        minimum_cli_version:
          type: string
          pattern: ^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)$
          title: Minimum Cli Version
      additionalProperties: false
      type: object
      required:
        - ref
        - minimum_cli_version
      title: EmbeddedRuntime
    ManagedMcpRuntime:
      properties:
        kind:
          type: string
          const: managed_local_mcp
          title: Kind
          default: managed_local_mcp
        ref:
          type: string
          pattern: >-
            ^com\.barndoor\.(cli|mcp)\.[a-z][a-z0-9_-]{0,99}$|^com\.barndoor\.tenant\.[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}\.[a-z][a-z0-9_-]{0,99}$
          title: Ref
        minimum_cli_version:
          type: string
          pattern: ^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)$
          title: Minimum Cli Version
        artifact:
          $ref: '#/components/schemas/SignedArtifact'
      additionalProperties: false
      type: object
      required:
        - ref
        - minimum_cli_version
        - artifact
      title: ManagedMcpRuntime
    LocalCliRuntime:
      properties:
        kind:
          type: string
          const: local_cli
          title: Kind
          default: local_cli
        ref:
          type: string
          pattern: >-
            ^com\.barndoor\.(cli|mcp)\.[a-z][a-z0-9_-]{0,99}$|^com\.barndoor\.tenant\.[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}\.[a-z][a-z0-9_-]{0,99}$
          title: Ref
        minimum_cli_version:
          type: string
          pattern: ^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)$
          title: Minimum Cli Version
        artifact:
          $ref: '#/components/schemas/SignedArtifact'
      additionalProperties: false
      type: object
      required:
        - ref
        - minimum_cli_version
        - artifact
      title: LocalCliRuntime
    RemoteRuntime:
      properties:
        kind:
          type: string
          const: remote
          title: Kind
          default: remote
      additionalProperties: false
      type: object
      title: RemoteRuntime
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    SignedArtifact:
      properties:
        key_id:
          type: string
          maxLength: 100
          minLength: 1
          title: Key Id
        manifest:
          type: string
          maxLength: 131072
          minLength: 1
          title: Manifest
        signature:
          type: string
          maxLength: 100
          minLength: 1
          title: Signature
      additionalProperties: false
      type: object
      required:
        - key_id
        - manifest
        - signature
      title: SignedArtifact
      description: |-
        Publisher-signed manifest envelope.

        The registry validates manifest *shape* only (schema, ref, allowed host,
        digest format, version pattern) — it has no publisher private key and
        cannot verify the Ed25519 signature itself. The CLI (internal/artifact)
        verifies `signature` over the exact `manifest` bytes against its pinned
        per-`key_id` trusted-publisher map before ever launching the artifact,
        and fails closed on an unknown key_id or a tampered manifest.
  securitySchemes:
    ApiKey:
      type: http
      scheme: bearer
      description: >-
        A Barndoor API key, sent as `Authorization: Bearer <key>`. Keys are
        prefixed `bdai_` and are opaque — do not attempt to decode one.
        Interchangeable with an OAuth 2.0 access token.
    OAuth2:
      type: oauth2
      x-issuer: https://auth.barndoor.ai/realms/barndoor
      description: >-
        An OAuth 2.0 access token from Barndoor's identity provider, sent as
        `Authorization: Bearer <token>`. Public clients must use PKCE.
        Interchangeable with an API key.
      flows:
        authorizationCode:
          authorizationUrl: >-
            https://auth.barndoor.ai/realms/barndoor/protocol/openid-connect/auth
          tokenUrl: >-
            https://auth.barndoor.ai/realms/barndoor/protocol/openid-connect/token
          scopes:
            openid: Issue an OIDC ID token identifying the caller.
            profile: Read the caller's basic profile claims.
            email: Read the caller's email address.
            offline_access: Issue a refresh token. Optional — no operation requires it.
        clientCredentials:
          tokenUrl: >-
            https://auth.barndoor.ai/realms/barndoor/protocol/openid-connect/token
          scopes:
            openid: Issue an OIDC ID token identifying the caller.
            profile: Read the caller's basic profile claims.
            email: Read the caller's email address.
            offline_access: Issue a refresh token. Optional — no operation requires it.

````

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