Toolfront

🚀 ToolFront

AI 智能体缺乏关于您数据库的上下文信息，而团队成员则不断重写相同的查询，因为过往的工作成果往往会丢失。ToolFront 将智能体与您的数据库连接起来，并为它们提供您团队经过验证的查询模式，这样智能体和团队成员就可以相互学习，从而更快地交付成果。

✨ 主要特性

• ⚡ 一步设置：通过单个命令或配置，将 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 问题 中报告错误或请求功能

贡献

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

📄 许可证

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