> ## 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 agent tool catalog

> Return every selectable agent tool, grouped by category.

Each tool is annotated with ``permitted`` (whether the caller's roles
allow it), ``risky`` (destructive or recursive crew-invoking tools), and
``default`` (granted when an agent selects nothing).



## OpenAPI

````yaml get /api/tools/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/tools/catalog:
    get:
      tags:
        - Tools
      summary: List agent tool catalog
      description: |-
        Return every selectable agent tool, grouped by category.

        Each tool is annotated with ``permitted`` (whether the caller's roles
        allow it), ``risky`` (destructive or recursive crew-invoking tools), and
        ``default`` (granted when an agent selects nothing).
      operationId: get_tool_catalog_api_tools_catalog_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ToolCatalogResponse'
      security:
        - OAuth2AuthorizationCodeBearer: []
        - APIKeyHeader: []
components:
  schemas:
    ToolCatalogResponse:
      properties:
        categories:
          items:
            $ref: '#/components/schemas/ToolCategoryItem'
          type: array
          title: Categories
        tools:
          items:
            $ref: '#/components/schemas/ToolCatalogItem'
          type: array
          title: Tools
        default_tool_ids:
          items:
            type: string
          type: array
          title: Default Tool Ids
          description: Tool ids granted to an agent that selects nothing.
      type: object
      required:
        - categories
        - tools
        - default_tool_ids
      title: ToolCatalogResponse
      description: The full selectable tool catalog for crew/agent configuration.
    ToolCategoryItem:
      properties:
        key:
          type: string
          title: Key
        label:
          type: string
          title: Label
        description:
          type: string
          title: Description
      type: object
      required:
        - key
        - label
        - description
      title: ToolCategoryItem
      description: Display metadata for a tool category.
    ToolCatalogItem:
      properties:
        id:
          type: string
          title: Id
          description: Stable tool id used in AgentConfig.tools.
        label:
          type: string
          title: Label
          description: Human-readable display label.
        description:
          type: string
          title: Description
          description: What the tool does.
        category:
          type: string
          title: Category
          description: Category key (see ToolCategoryItem.key).
        surface:
          type: string
          title: Surface
          description: '''crew'' (default toolset) or ''service''.'
        roles:
          items:
            type: string
          type: array
          title: Roles
          description: Roles that unlock this tool.
        risky:
          type: boolean
          title: Risky
          description: True for destructive (delete_*) or recursive crew-invoking tools.
        default:
          type: boolean
          title: Default
          description: True if granted when an agent makes no tool selection.
        permitted:
          type: boolean
          title: Permitted
          description: True if the calling user's roles allow this tool.
      type: object
      required:
        - id
        - label
        - description
        - category
        - surface
        - roles
        - risky
        - default
        - permitted
      title: ToolCatalogItem
      description: One selectable tool, annotated for the calling user.
  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

````