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 文件。