Toolfront

🚀 ToolFront

ToolFront能将AI智能体与你的数据库连接起来，并为它们提供团队中经过验证的查询模式，从而使智能体和团队成员能够相互学习，加快项目交付速度。它解决了AI智能体缺乏数据库上下文，以及团队重复编写相同查询的问题。

✨ 主要特性

• ⚡ 一步设置：通过单个命令或配置，即可将Cursor、GitHub Copilot和Claude等编码智能体连接到你所有的数据库。
• 🔒 隐私至上：你的数据不会离开本地，仅通过安全的MCP服务器在智能体和数据库之间共享。
• 🧠 协作学习：团队使用ToolFront的次数越多，AI智能体就越能理解你的数据库和查询模式。此功能需要API密钥。

🚀 快速开始

ToolFront通过MCP服务器在你的计算机上运行，MCP是一种安全协议，可让应用程序为大语言模型提供上下文。

前提条件

• uv 或 Docker 来运行MCP服务器（推荐使用 uv）
• 你的数据库的数据库连接URL - 见下文
• API密钥（可选）以激活协作学习 - 见下文

在IDE中运行ToolFront

首先，通过点击上面的设置按钮或导航到IDE的MCP设置来创建一个MCP配置：

然后，使用你的数据库连接URL和可选的API密钥编辑MCP配置：

{
  // 配置文件的其余部分
  "toolfront": {
    "command": "uvx",
    "args": [
      "toolfront",
      "snowflake://user:pass@org",
      "postgresql://user:pass@host:port/db",
      # 在此处添加其他数据库URL
      "--api-key", "YOUR-API-KEY"  // 可选
    ]
  }
}

{
  // 配置文件的其余部分
  "toolfront": {
    "command": "docker",
    "args": [
      "run",
      "-i",
      "antidmg/toolfront",
      "snowflake://user:pass@org",
      "postgresql://user:pass@host:port/db",
      # 在此处添加其他数据库URL
      "--api-key", "YOUR-API-KEY"  // 可选
    ]
  }
}

你已经设置好了！现在你可以向编码助手询问有关数据库的问题了。

💡 使用建议 版本控制：你可以固定到特定版本以保持一致性。对于UV，使用 toolfront==0.1.x；对于Docker，使用 antidmg/toolfront:0.1.x。

在终端中运行ToolFront

要在IDE之外使用ToolFront，请直接在终端中使用数据库URL和可选的API密钥运行它：

# 使用UV
uvx toolfront "snowflake://user:pass@org" "postgresql://user:pass@host:port/db" --api-key "YOUR-API-KEY"

# 使用Docker  
docker run -i antidmg/toolfront "snowflake://user:pass@org" "postgresql://user:pass@host:port/db" --api-key "YOUR-API-KEY"

💡 使用建议 本地数据库：连接到本地运行的数据库时，在镜像名称前添加 --network host。

📚 协作式上下文学习

数据团队经常重复编写相同的查询，因为过去的工作往往被孤立、分散或丢失。ToolFront通过上下文学习教会AI智能体你的团队如何使用数据库。有了ToolFront，你的智能体可以：

• 分析历史查询模式
• 记住相关的表和模式
• 参考你和团队成员的工作

⚠️ 重要提示 上下文学习目前处于开放测试阶段。如需申请API密钥，请发邮件给Esteban，邮箱地址为 esteban@kruskal.ai，或加入我们的 Discord服务器。

📚 支持的数据库

ToolFront支持以下数据库：

如果你使用的数据库不在列表中，请提交一个问题或拉取请求，或者在我们的 Discord 中告知我们！

💡 使用建议 SSH隧道：对于位于SSH堡垒后面的数据库，在URL中添加SSH参数：postgresql://user:pass@db:5432/database?ssh_host=bastion&ssh_user=ubuntu&ssh_password=pass，或者使用 ssh_key_path=/path/to/key.pem 进行密钥认证。

处理本地数据文件？ 在你的配置中添加 duckdb://:memory: 以分析本地的Parquet、CSV、Excel或JSON文件。

📚 工具

MCP工具是AI智能体可以调用的函数，用于与外部系统进行交互。ToolFront附带了七个数据库工具：

📚 常见问题解答

📚 支持与社区

需要ToolFront方面的帮助？我们随时提供支持：

• Discord：加入我们的 社区服务器 以获取实时帮助和讨论
• 问题反馈：在 GitHub Issues 上报告错误或请求功能

📚 贡献代码

有关如何为ToolFront做出贡献的指南，请参阅 CONTRIBUTING.md。

📄 许可证

ToolFront根据 MIT许可证 发布。这意味着你可以自由使用、修改和分发该软件，但需遵守MIT许可证的条款和条件。完整的许可证文本请参阅仓库中的 LICENSE 文件。