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

> ## Agent Instructions
> To act on Atlan objects, use the Atlan MCP server at https://api.atlan.com/mcp or the SDK. To install or publish skills from a terminal, use the `aireg` CLI; `aireg --map json` prints its command map. The `atlanai` CLI is deprecated. Run a read-only identity check before any write.
> The docs MCP server at /mcp searches these docs only. It cannot read or change Atlan objects.
> SDK packages: Python `atlanai` (PyPI) and TypeScript `@atlanai/sdk` (npm). Show Python first, then TypeScript.
> These docs cover Atlan Trident, Atlan's hosted product. AI Registry and Agent Registry are its earlier names. Registry OSS is Atlan's open-source agent registry: the registry specification and its aireg CLI, with their own public repository, docs and release notes; /open-source on this site links them. Registry OSS is open source; Atlan Trident is not. Answer generic aireg or specification questions from the project's docs, and use these docs for Atlan-specific setup such as the Atlan adapter, sign-in and workspaces.

# Try one endpoint of an MCP definition



## OpenAPI

````yaml /public-openapi.json post /mcp/v1/definitions/{definition_id}/test
openapi: 3.1.0
info:
  title: Atlan public API
  version: current
  description: >-
    Public HTTP API reference for Registry, Skills, Agents, outputs, files, MCP
    servers and tools, Model Gateway, and OTLP telemetry ingestion.
servers:
  - url: https://api.atlan.com
    description: Atlan API base URL
security:
  - bearer: []
tags:
  - name: Core
  - name: Skill
  - name: Agent
  - name: Files
  - name: Knowledge
  - name: MCP
  - name: Observability
  - name: API proxy
  - name: Credentials
  - name: Store
  - name: Apps
  - name: Evals
  - name: Ontologies
  - name: Ontology bindings
  - name: Slack
  - name: GitHub
  - name: Objectives
  - name: Repositories
  - name: Models
paths:
  /mcp/v1/definitions/{definition_id}/test:
    post:
      tags:
        - MCP
      summary: Try one endpoint of an MCP definition
      operationId: mcp.testDefinition
      parameters:
        - in: path
          name: definition_id
          required: true
          schema:
            type: string
        - name: Content-Encoding
          in: header
          required: false
          schema:
            type: string
            enum:
              - base64
              - gzip, base64
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/mcp-mcp-TestDefinition'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/mcp-mcp-TestedDefinition'
          description: HTTP 200 response.
        '400':
          content:
            application/problem+json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/mcp-ProblemDetails'
                  - properties:
                      code:
                        enum:
                          - invalid_base64
                          - invalid_gzip
                          - invalid_json
                          - invalid_query
                          - invalid_request
                        type: string
                    required:
                      - code
                    type: object
          description: HTTP 400 response.
        '401':
          content:
            application/problem+json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/mcp-ProblemDetails'
                  - type: object
                    required:
                      - code
                    properties:
                      code:
                        type: string
                        enum:
                          - alg_mismatch
                          - alg_not_allowed
                          - audience_mismatch
                          - invalid_api_key
                          - missing_identity
                          - missing_org
                          - missing_user
                          - signature_invalid
                          - token_expired
                          - token_malformed
                          - token_missing
                          - token_not_yet_valid
                          - token_rejected
                          - token_service_account_unbound
                          - unauthorized
                          - unknown_account
                          - unknown_key
                          - untrusted_issuer
          description: HTTP 401 response.
        '403':
          content:
            application/problem+json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/mcp-ProblemDetails'
                  - type: object
                    required:
                      - code
                    properties:
                      code:
                        type: string
                        enum:
                          - access_denied
                          - account_suspended
                          - forbidden
                          - platform_principal_refused
          description: HTTP 403 response.
        '404':
          content:
            application/problem+json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/mcp-ProblemDetails'
                  - type: object
                    required:
                      - code
                    properties:
                      code:
                        type: string
                        enum:
                          - not_found
          description: HTTP 404 response.
        '413':
          content:
            application/problem+json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/mcp-ProblemDetails'
                  - type: object
                    required:
                      - code
                    properties:
                      code:
                        type: string
                        enum:
                          - compressed_payload_too_large
                          - decompressed_payload_too_large
                          - payload_too_large
          description: HTTP 413 response.
        '415':
          content:
            application/problem+json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/mcp-ProblemDetails'
                  - type: object
                    required:
                      - code
                    properties:
                      code:
                        type: string
                        enum:
                          - unsupported_content_encoding
                          - unsupported_content_type
          description: HTTP 415 response.
        '422':
          content:
            application/problem+json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/mcp-ProblemDetails'
                  - type: object
                    required:
                      - code
                    properties:
                      code:
                        type: string
                        enum:
                          - validation_failed
          description: HTTP 422 response.
        '429':
          content:
            application/problem+json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/mcp-ProblemDetails'
                  - type: object
                    required:
                      - code
                    properties:
                      code:
                        type: string
                        enum:
                          - rate_limited
          description: HTTP 429 response.
        '500':
          content:
            application/problem+json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/mcp-ProblemDetails'
                  - type: object
                    required:
                      - code
                    properties:
                      code:
                        type: string
                        enum:
                          - internal_error
          description: HTTP 500 response.
        '503':
          content:
            application/problem+json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/mcp-ProblemDetails'
                  - type: object
                    required:
                      - code
                    properties:
                      code:
                        type: string
                        enum:
                          - auth_unavailable
                          - service_overloaded
                          - service_unavailable
          description: HTTP 503 response.
        '504':
          content:
            application/problem+json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/mcp-ProblemDetails'
                  - type: object
                    required:
                      - code
                    properties:
                      code:
                        type: string
                        enum:
                          - request_timeout
          description: HTTP 504 response.
components:
  schemas:
    mcp-mcp-TestDefinition:
      additionalProperties: false
      properties:
        inputs:
          additionalProperties:
            type: string
          propertyNames:
            type: string
          type: object
        remote_index:
          type: integer
          format: int32
          minimum: 0
        version:
          type:
            - integer
            - 'null'
          format: int64
      required:
        - remote_index
      type: object
    mcp-mcp-TestedDefinition:
      properties:
        definition_version_id:
          type: string
        endpoint_url:
          type:
            - string
            - 'null'
        error:
          type:
            - string
            - 'null'
        probe:
          oneOf:
            - $ref: '#/components/schemas/mcp-mcp-McpDiscoverResponse'
            - type: 'null'
      required:
        - definition_version_id
      type: object
    mcp-ProblemDetails:
      type: object
      required:
        - title
        - status
        - detail
        - code
      properties:
        code:
          type: string
        detail:
          type: string
        status:
          type: integer
          format: int32
          minimum: 0
        title:
          type: string
        trace_id:
          type:
            - string
            - 'null'
    mcp-mcp-McpDiscoverResponse:
      properties:
        auth:
          type:
            - string
            - 'null'
        callback_url_template:
          type:
            - string
            - 'null'
        challenge:
          oneOf:
            - $ref: '#/components/schemas/mcp-mcp-McpDiscoverChallenge'
            - type: 'null'
        is_reachable:
          type: boolean
        oauth:
          oneOf:
            - $ref: '#/components/schemas/mcp-mcp-McpDiscoverOauth'
            - type: 'null'
        problem:
          type:
            - string
            - 'null'
        server_title:
          type:
            - string
            - 'null'
        tool_count:
          minimum: 0
          type:
            - integer
            - 'null'
      required:
        - is_reachable
      type: object
    mcp-mcp-McpDiscoverChallenge:
      properties:
        realm:
          type:
            - string
            - 'null'
        scheme:
          type: string
      required:
        - scheme
      type: object
    mcp-mcp-McpDiscoverOauth:
      properties:
        authorization_url:
          type: string
        client_strategy:
          type: string
        existing_provider:
          oneOf:
            - $ref: '#/components/schemas/mcp-mcp-McpExistingProvider'
            - type: 'null'
        issuer:
          type: string
        resource:
          type: string
        scope_hint:
          type:
            - string
            - 'null'
        scopes_supported:
          type: array
          items:
            type: string
        token_url:
          type: string
      required:
        - resource
        - issuer
        - authorization_url
        - token_url
        - scopes_supported
        - client_strategy
      type: object
    mcp-mcp-McpExistingProvider:
      properties:
        client_status:
          type: string
        is_enabled:
          type: boolean
        key:
          type: string
      required:
        - key
        - is_enabled
        - client_status
      type: object
  securitySchemes:
    bearer:
      bearerFormat: JWT
      scheme: bearer
      type: http

````

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