GenAI Toolbox 项目使用教程

GenAI Toolbox 项目使用教程

genai-toolbox MCP Toolbox for Databases is an open source MCP server for databases, designed and built with enterprise-quality and production-grade usage in mind. 项目地址: https://gitcode.com/gh_mirrors/ge/genai-toolbox

1. 项目目录结构及介绍

GenAI Toolbox 是一个开源项目，旨在帮助开发者更容易、更快、更安全地开发和部署数据库相关的工具。以下是项目的目录结构及其简要介绍：

genai-toolbox/
├── .ci/              # CI 配置文件
├── .github/          # GitHub 工作流配置
├── .hugo/            # Hugo 静态网站生成器配置
├── cmd/              # 主应用程序入口
├── docs/             # 文档资料
├── internal/         # 内部模块和工具
├── tests/            # 测试文件
├── .gitignore        # Git 忽略文件
├── .gitmodules       # 子模块配置
├── .golangci.yaml    # gofmt 和 golint 配置
├── CHANGELOG.md      # 更新日志
├── CODE_OF_CONDUCT.md# 行为准则
├── CONTRIBUTING.md   # 贡献指南
├── DEVELOPER.md      # 开发者文档
├── Dockerfile        # Docker 容器构建文件
├── LICENSE           # 开源许可证
├── README.md         # 项目介绍
├── go.mod            # Go 依赖管理
├── go.sum            # Go 依赖校验
└── logo.png          # 项目Logo

2. 项目的启动文件介绍

项目的启动文件位于 cmd 目录中，通常是 main.go。这是 GenAI Toolbox 的主要入口点，它负责初始化和启动服务。

// main.go
package main

func main() {
    // 初始化和启动服务的代码
}

在这个文件中，你将配置和启动 GenAI Toolbox 服务，通常会加载配置文件，设置数据库连接，以及启动 HTTP 服务器等。

3. 项目的配置文件介绍

GenAI Toolbox 的配置主要通过 tools.yaml 文件进行。这个文件定义了数据源、工具和工具集，使得开发者可以轻松地配置和管理项目。

以下是 tools.yaml 文件的一个基本示例：

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

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: The name of the hotel.
    statement: SELECT * FROM hotels WHERE name ILIKE '%' || $1 || '%';

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

在这个配置文件中：

• sources 定义了数据源，这里是 PostgreSQL 数据库的连接信息。
• tools 定义了工具，这里是执行 SQL 查询的一个工具。
• toolsets 定义了工具集，可以按需加载一组工具。

开发者可以通过修改这个文件来调整数据源配置、工具定义和工具集，以适应不同的使用场景。

genai-toolbox MCP Toolbox for Databases is an open source MCP server for databases, designed and built with enterprise-quality and production-grade usage in mind. 项目地址: https://gitcode.com/gh_mirrors/ge/genai-toolbox