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

# Get tool detail

> Get detailed information about a specific tool.



## OpenAPI

````yaml /openapi/service-api-en.json get /api/v1/tools/{tool_name}
openapi: 3.0.3
info:
  title: LangBot Service API
  description: >
    LangBot external service API documentation. These endpoints support API Key
    authentication for programmatic access to LangBot resources.


    **Authentication:**

    - User Token (via `Authorization: Bearer <token>`)

    - API Key (via `X-API-Key: <key>` or `Authorization: Bearer <key>`)


    All endpoints in this document support both authentication methods unless
    otherwise noted.
  version: 4.9.5
  contact:
    name: LangBot
    url: https://langbot.app
  license:
    name: AGPL-3.0
    url: https://github.com/langbot-app/LangBot/blob/master/LICENSE
servers:
  - url: http://localhost:5300
    description: Local development server
security:
  - ApiKeyAuth: []
  - BearerAuth: []
tags:
  - name: Model Providers
    description: >-
      Model provider management. Providers define API endpoints and keys; models
      reference providers via provider_uuid.
  - name: LLM Models
    description: >-
      Large Language Model (LLM) management. Each model is associated with a
      provider.
  - name: Embedding Models
    description: Embedding model management. Each model is associated with a provider.
  - name: Bots
    description: Bot instance management and messaging
  - name: Pipelines
    description: Pipeline configuration management
  - name: Knowledge Bases
    description: Knowledge base management
  - name: Knowledge Engines
    description: Knowledge engine (plugin-provided) queries
  - name: Parsers
    description: File parser (plugin-provided) queries
  - name: Files
    description: File upload operations
  - name: Plugins
    description: Plugin installation, configuration, and management
  - name: System
    description: System information (no auth required)
paths:
  /api/v1/tools/{tool_name}:
    get:
      tags:
        - Tools
      summary: Get tool detail
      description: Get detailed information about a specific tool.
      operationId: getToolDetail
      parameters:
        - name: tool_name
          in: path
          required: true
          schema:
            type: string
          description: Tool name
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: integer
                    example: 0
                  msg:
                    type: string
                    example: ok
                  data:
                    type: object
                    properties:
                      tool:
                        $ref: '#/components/schemas/ToolSummary'
        '404':
          description: Tool not found
      security:
        - BearerAuth: []
components:
  schemas:
    ToolSummary:
      type: object
      properties:
        name:
          type: string
          description: Tool name
        label:
          type: object
          description: Display label (i18n)
          additionalProperties:
            type: string
        description:
          type: object
          description: Tool description (i18n)
          additionalProperties:
            type: string
        icon:
          type: string
          description: Tool icon
        spec:
          type: object
          description: Tool specification
          properties:
            llm_prompt:
              type: string
            parameters:
              type: object
              description: JSON Schema for tool parameters
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
    BearerAuth:
      type: http
      scheme: bearer

````