Genai Toolbox

🚀 Toolbox Project Documentation

Toolbox is a comprehensive platform for managing tools and data sources. It supports multiple interaction methods and offers flexible configuration options. Users can easily define data sources, tools, and their parameters through the tools.yaml file.

🚀 Quick Start

📦 Installation

Quick Installation

# Clone the repository
git clone https://github.com/your-repository.git
cd your-repository

# Install dependencies
pip install -r requirements.txt

# Start the service
python main.py

Configure Environment Variables

Before starting Toolbox, it is recommended to configure the following environment variables:

export TOOLBOX_HOME=~/toolbox-config
export DB_URL=postgresql://user:password@localhost:5432/database

✨ Features

Core Functions

• Data Source Management: Supports multiple database types, such as PostgreSQL and MySQL.
• Tool Definition: Allows users to customize SQL queries and other types of tool operations.
• Toolset Management: Through the toolsets feature, users can combine multiple tools for use.

Example Configurations

Data Source Configuration (sources.yaml)

sources:
  my-pg-source:
    kind: postgres
    host: 127.0.0.1
    port: 5432
    database: toolbox_db
    user: toolbox_user
    password: my-password

Tool Configuration (tools.yaml)

tools:
  search-hotels-by-name:
    kind: postgres-sql
    source: my-pg-source
    description: Search for hotels based on name.
    parameters:
      - name: name
        type: string
        description: Hotel name.
    statement: SELECT * FROM hotels WHERE name ILIKE '%' || $1 || '%';

Toolset Configuration (toolsets.yaml)

toolsets:
  my_first_toolset:
    - my_first_tool
    - my_second_tool
  my_second_toolset:
    - my_second_tool
    - my_third_tool

📚 Documentation

Data Source Configuration

In the sources.yaml file, users can define multiple data sources. Each data source has a unique identifier and related connection parameters.

Example:

sources:
  pg_source1:
    kind: postgres
    host: 127.0.0.1
    port: 5432
    database: testdb
    user: admin
    password: secret

Tool Configuration

In the tools.yaml file, users can define multiple tools. Each tool has a unique identifier, type, associated data source, and specific operations to be executed.

Example:

tools:
  get_user_info:
    kind: postgres-sql
    source: pg_source1
    description: Get user information.
    parameters:
      - name: user_id
        type: integer
        description: User ID.
    statement: SELECT * FROM users WHERE id = $1;

Toolset Configuration

Through the toolsets.yaml file, users can combine multiple tools to form a tool group. This makes it more convenient to manage and use tools in practical applications.

Example:

toolsets:
  user_management_toolset:
    - get_user_info
    - update_user_profile
  data_analysis_toolset:
    - fetch_data
    - analyze_results

🔧 Version Control

This project follows Semantic Versioning, with the format MAJOR.MINOR.PATCH. The specific meanings are as follows:

• MAJOR: Increase the major version number when there are changes in major functions or backward incompatibilities.
• MINOR: Increase the minor version number when new features are added or existing features are improved without breaking backward compatibility.
• PATCH: Increase the patch version number when known issues and vulnerabilities are fixed.

🤝 Contribution Guide

How to Contribute Code

1. Fork the repository
2. Create a feature branch
3. Commit your code
4. Submit a Pull Request

Example commit message format:

feat: Add new tool configuration function
fix: Fix data source connection issue
docs: Update documentation

How to Report Issues

Please report any issues or provide feedback through the following channels:

• GitHub Issues: https://github.com/your-repository/issues
• Email: support@toolbox.com

📎 Appendix

Frequently Asked Questions (FAQ)

1. How to configure environment variables?
   • Follow the "Configure Environment Variables" section in the documentation.
2. Which database types are supported?
   • Currently, PostgreSQL and MySQL are supported, and more types are planned to be added in the future.
3. How to define a new tool?
   • Add a new tool entry in the tools.yaml file and ensure its syntax is correct.

Contact Information

• Official Website: https://www.toolbox.com
• Developer Mailing List: dev@toolbox.com
• Chinese Community: https://community.toolbox.com/c/zh-CN

Thank you for using Toolbox! If you need further assistance, please feel free to contact our support team.