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

# List the chat tools a set of realm roles may call

> The tools the assistant can offer someone holding these roles, with their descriptions and argument schemas, read from the running MCP server. It is for a proxy that narrows a turn's tool list to the few a question is about, so it needs to know what exists and what each tool is for.

A tool listed here is one the roles may call, not one a given chat turn has registered: a turn's toolset also depends on the page the chat was opened beside, the context packs attached and the registry servers connected. Treat it as a catalogue, never as grounds for offering a tool a request did not carry.

Only the platform PSK may read it. It reports another person's reachable tools, so a Keycloak token or a personal PSK is refused.



## OpenAPI

````yaml get /api/chat/tool-catalog
openapi: 3.1.0
info:
  title: Nx1 AI API
  description: |

    AI API for Nx1 Data Platform Management and Automated Data Tasks.

    Authentication is required via PSK in Authorization header.

    Default PSK is | [ask a friend] |
  version: 0.10.2
servers: []
security: []
paths:
  /api/chat/tool-catalog:
    get:
      tags:
        - Chat
      summary: List the chat tools a set of realm roles may call
      description: >-
        The tools the assistant can offer someone holding these roles, with
        their descriptions and argument schemas, read from the running MCP
        server. It is for a proxy that narrows a turn's tool list to the few a
        question is about, so it needs to know what exists and what each tool is
        for.


        A tool listed here is one the roles may call, not one a given chat turn
        has registered: a turn's toolset also depends on the page the chat was
        opened beside, the context packs attached and the registry servers
        connected. Treat it as a catalogue, never as grounds for offering a tool
        a request did not carry.


        Only the platform PSK may read it. It reports another person's reachable
        tools, so a Keycloak token or a personal PSK is refused.
      operationId: get_tool_catalog_api_chat_tool_catalog_get
      parameters:
        - name: role
          in: query
          required: false
          schema:
            anyOf:
              - items:
                  type: string
                type: array
              - type: 'null'
            description: >-
              A realm role the caller holds; repeat for each. Omitted means no
              roles, which lists only the ungated tools.
            title: Role
          description: >-
            A realm role the caller holds; repeat for each. Omitted means no
            roles, which lists only the ungated tools.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChatToolCatalogResponse'
        '401':
          description: Unauthorized
        '403':
          description: Only the platform PSK may read the tool catalogue.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - OAuth2AuthorizationCodeBearer: []
        - APIKeyHeader: []
components:
  schemas:
    ChatToolCatalogResponse:
      properties:
        roles:
          items:
            type: string
          type: array
          title: Roles
          description: The realm roles this catalogue was built for.
        tools:
          items:
            $ref: '#/components/schemas/ChatCatalogTool'
          type: array
          title: Tools
          description: The tools, in name order.
      type: object
      title: ChatToolCatalogResponse
      description: The chat tools a caller holding a given set of realm roles may call.
    ErrorResponse:
      properties:
        error:
          type: string
          title: Error
          description: A brief description of the error that occurred.
        code:
          type: integer
          title: Code
          description: The HTTP status code associated with the error.
          default: 500
      type: object
      required:
        - error
      title: ErrorResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ChatCatalogTool:
      properties:
        name:
          type: string
          title: Name
          description: The tool's name, as the model would call it.
        description:
          type: string
          title: Description
          description: What the tool does; what a query is matched against.
          default: ''
        parameters:
          additionalProperties: true
          type: object
          title: Parameters
          description: JSON Schema for the tool's arguments.
      type: object
      required:
        - name
      title: ChatCatalogTool
      description: One tool in the chat catalogue, as a tool-selecting proxy reads it.
    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
  securitySchemes:
    OAuth2AuthorizationCodeBearer:
      type: oauth2
      flows:
        authorizationCode:
          scopes: {}
          authorizationUrl: >-
            https://sso-rapid.rapid.nx1cloud.com/realms/rapid/protocol/openid-connect/auth
          tokenUrl: >-
            https://sso-rapid.rapid.nx1cloud.com/realms/rapid/protocol/openid-connect/token
    APIKeyHeader:
      type: apiKey
      in: header
      name: Authorization-PSK

````

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