Tools Documentation

Overview

The Tools component provides a powerful and extensible framework for implementing and managing external tool integrations. This module serves as the backbone for all external interactions, enabling the system to perform specific actions and retrieve information from various services.

---

graph TB
    A[Client Request] --> Z[Tool Registry]
    Z --> B{Tool Selection}

    B --> F["REST Tool Implementations<br><small>(e.g., WeatherTool, WikipediaTool,<br>DuckDuckGoSearchTool)</small>"]
    B --> G["Custom Tool Implementations<br><small>(e.g., RAGTool, Custom Tools)</small>"]

    F --> H[External APIs]
    G --> I[External Services]
    G --> J["Local Operations<br><small>(e.g., Calculator, Graphing,<br>Python Execution)</small>"]

    style A stroke:#333,stroke-width:2px
    style Z stroke:#333,stroke-width:2px
    style B stroke:#333,stroke-width:2px
    style F stroke:#333,stroke-width:1px
    style G stroke:#333,stroke-width:1px
    style J stroke:#333,stroke-width:1px

---

Component Architecture

Tool Execution Flow (API Tool Example)

sequenceDiagram
    participant C as Client
    participant R as ToolRegistry
    participant T as Tool
    participant E as External Service

    C->>R: Execute Tool Request
    R->>T: Execute Tool
    T->>E: API Request
    E-->>T: Response
    T-->>C: Processed Result

---

Core Components

Base Tool Interfaces

Located in src/tools/core/:

• BaseTool

  • Foundation interface for all tools
  • Defines standard execution patterns
  • See Base Tool

• BaseRESTTool

  • Extended functionality for REST APIs
  • Built-in HTTP method handling
  • See Base Rest Tool

• ToolRegistry

  • Central tool management system
  • Handles tool registration and access
  • See Tool Registry

Example Tool Implementations

Located in src/tools/implementations/:

• RAGTool

  • Retrieval-Augmented Generation
  • Enhances responses with external knowledge
  • See Rag Tool Example

• WeatherTool

  • Weather information service integration
  • Real-time weather data access
  • See Weather Tool Example

• WikipediaTool

  • Wikipedia article retrieval and summarization
  • Access to comprehensive knowledge base
  • See Wikipedia Tool Example

Utils

Located in src/tools/core/utils/:

• TokenManager

  • OAuth2 credential management
  • Secure token handling
  • See Token Manager

Parsers

Located in src/tools/core/parsers/:

• BaseToolCallParser

  • Abstract parsing interface
  • See Base Parser

• JSONToolCallParser

  • JSON format handling
  • See JSON Parser

• NonJSONToolCallParser

  • Alternative format support
  • See Non-JSON Parser

---

Further Documentation

• See Base Tool for custom tool creation
• See Base REST Tool for REST implementation details
• Check Tool Implementations for specific tool documentation
• Visit Parsers for parsing documentation
• Explore Utils for utility references

---

Security Best Practices

1. Always use environment variables for sensitive credentials
2. Implement proper request validation
3. Use HTTPS for external communications
4. Follow least privilege principle
5. Regularly audit tool access patterns

---