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

# List Tools

> List all available agent tools.

Use this endpoint to discover available tools before creating a session.

Tool Categories:
- search: Tools for searching data (execute_retriever)
- read: Tools for reading resources (list_*, get_*)
- create: Tools for creating resources (create_*) - requires confirmation
- update: Tools for updating resources (update_*) - requires confirmation
- delete: Tools for deleting resources (delete_*) - requires confirmation
- upload: Tools for file uploads (upload_object)

Note: Write operations (create, update, delete) require user confirmation
via the /confirmations endpoint before execution.

Args:
    request: FastAPI request with tenant context
    category: Optional filter by tool category

Returns:
    ListToolsResponse with available tools

Example:
    ```bash
    # List all tools
    curl -X GET http://localhost:8000/v1/agents/tools \
      -H "Authorization: Bearer {api_key}" \
      -H "X-Namespace: {namespace_id}"

    # List only search tools
    curl -X GET "http://localhost:8000/v1/agents/tools?category=search" \
      -H "Authorization: Bearer {api_key}" \
      -H "X-Namespace: {namespace_id}"
    ```



## OpenAPI

````yaml get /v1/agents/sessions/tools
openapi: 3.1.0
info:
  title: Mixpeek API
  description: >-
    This is the Mixpeek API, providing access to various endpoints for data
    processing and retrieval.
  termsOfService: https://mixpeek.com/terms
  contact:
    name: Mixpeek Support
    url: https://mixpeek.com/contact
    email: info@mixpeek.com
  version: '0.82'
servers:
  - url: https://api.mixpeek.com
    description: Production
security: []
paths:
  /v1/agents/sessions/tools:
    get:
      tags:
        - Agent Sessions
      summary: List Tools
      description: >-
        List all available agent tools.


        Use this endpoint to discover available tools before creating a session.


        Tool Categories:

        - search: Tools for searching data (execute_retriever)

        - read: Tools for reading resources (list_*, get_*)

        - create: Tools for creating resources (create_*) - requires
        confirmation

        - update: Tools for updating resources (update_*) - requires
        confirmation

        - delete: Tools for deleting resources (delete_*) - requires
        confirmation

        - upload: Tools for file uploads (upload_object)


        Note: Write operations (create, update, delete) require user
        confirmation

        via the /confirmations endpoint before execution.


        Args:
            request: FastAPI request with tenant context
            category: Optional filter by tool category

        Returns:
            ListToolsResponse with available tools

        Example:
            ```bash
            # List all tools
            curl -X GET http://localhost:8000/v1/agents/tools \
              -H "Authorization: Bearer {api_key}" \
              -H "X-Namespace: {namespace_id}"

            # List only search tools
            curl -X GET "http://localhost:8000/v1/agents/tools?category=search" \
              -H "Authorization: Bearer {api_key}" \
              -H "X-Namespace: {namespace_id}"
            ```
      operationId: list_tools_v1_agents_sessions_tools_get
      parameters:
        - name: category
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Filter by tool category
            title: Category
          description: Filter by tool category
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListToolsResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    ListToolsResponse:
      properties:
        results:
          items:
            $ref: '#/components/schemas/ToolInfo'
          type: array
          title: Results
          description: Available tools
        total:
          type: integer
          title: Total
          description: Total number of tools
        categories:
          items:
            type: string
          type: array
          title: Categories
          description: Unique tool categories
      type: object
      required:
        - results
        - total
        - categories
      title: ListToolsResponse
      description: >-
        Response for listing available agent tools.


        Use this endpoint to discover available tools before creating a session.

        Pass tool names to available_tools in AgentConfig when creating a
        session.


        Attributes:
            results: List of available tools with descriptions
            total: Total number of tools available
            categories: Unique tool categories

        Example:
            ```python
            response = ListToolsResponse(
                results=[
                    ToolInfo(name="smart_search", description="...", category="search"),
                    ToolInfo(name="list_collections", description="...", category="read"),
                ],
                total=25,
                categories=["search", "read", "create"]
            )
            ```
    ErrorResponse:
      properties:
        success:
          type: boolean
          title: Success
          description: Always false for error responses
          default: false
        status:
          type: integer
          title: Status
          description: HTTP status code for this error
        error:
          $ref: '#/components/schemas/ErrorDetail'
          description: Error details payload
      type: object
      required:
        - status
        - error
      title: ErrorResponse
      description: Error response model.
      examples:
        - error:
            details:
              id: ns_123
              resource: namespace
            message: Namespace not found
            type: NotFoundError
          status: 404
          success: false
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ToolInfo:
      properties:
        name:
          type: string
          title: Name
          description: Tool name
        description:
          type: string
          title: Description
          description: Tool description
        category:
          type: string
          title: Category
          description: Tool category
        parameters:
          additionalProperties: true
          type: object
          title: Parameters
          description: Parameter definitions
        required_params:
          items:
            type: string
          type: array
          title: Required Params
          description: Required parameters
        requires_confirmation:
          type: boolean
          title: Requires Confirmation
          description: Whether the tool requires user confirmation
          default: false
      type: object
      required:
        - name
        - description
        - category
      title: ToolInfo
      description: |-
        Information about an available agent tool.

        Attributes:
            name: Tool name (use this in available_tools)
            description: What the tool does
            category: Tool category (search, read, create, etc.)
            parameters: Parameter definitions
            required_params: List of required parameter names
            requires_confirmation: Whether the tool requires user confirmation before execution
    ErrorDetail:
      properties:
        message:
          type: string
          title: Message
          description: Human-readable error message
        type:
          type: string
          title: Type
          description: Stable error type identifier (machine-readable)
        code:
          anyOf:
            - type: string
            - type: 'null'
          title: Code
          description: >-
            Fine-grained error code for programmatic handling (e.g.,
            namespace_name_taken, feature_extractor_not_found). Present only
            when consumers may need to branch on a specific error condition.
        details:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Details
          description: >-
            Optional structured details to help debugging (validation errors,
            IDs, etc.)
      type: object
      required:
        - message
        - type
      title: ErrorDetail
      description: Error detail model.
    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

````