Heimdall

🚀 他imdall

Heimdall 是一個輕量級服務，用於管理本地 MCP 服務器，通過單個 npx 命令即可輕鬆安裝。它能為 MCP 客戶端授權特定的 MCP 服務器工具，且相同配置對設備上的所有 MCP 客戶端都適用。

🚀 快速開始

Heimdall 能幫助你便捷地管理本地 MCP 服務器，通過簡單的命令即可完成安裝和配置。

✨ 主要特性

• 輕量級服務，易於安裝和使用。
• 可通過單個 npx 命令完成安裝。
• 能為 MCP 客戶端授權特定的 MCP 服務器工具。
• 相同配置適用於設備上的所有 MCP 客戶端。

📦 安裝指南

⚠️ 重要提示

我們強烈建議在安裝前備份您的 MCP 服務器配置，以防止意外的數據丟失。

安裝腳本執行以下關鍵操作:

• 將指定路徑的 mcpServers 配置 JSON 移動到 ~/.heimdall/config.json
• 在之前 mcpServers 配置路徑的位置插入一個 heimdall 的配置
• 初始化控制文件 ~/.heimdall/controls.json 以授權所有服務器上的所有方法

有關如何修改 ~/.heimdall/controls.json 以限制給定服務器的授權工具以及在 ~/.heimdall/config.json 中添加新服務器，請參閱配置。

使用 NPX（推薦）

運行安裝腳本（如果沒有指定路徑，則生成空配置）：

npx @shinzolabs/heimdall setup <可選: path/to/current/config.json>

使用本地實例

1. 下載包：

git clone https://github.com/shinzo-labs/heimdall.git

2. 安裝並構建依賴項：

cd heimdall && pnpm i && pnpm build

3. 運行安裝腳本（如果沒有指定路徑，則生成空配置）：

pnpm run setup <可選: path/to/current/config.json> <可選: `index.js` 文件在本地 Heimdall 實例中的路徑，例如 `/path/to/local/heimdall/dist/index.js`>

📚 詳細文檔

配置

編輯服務器列表

要添加或更新可用服務器，請直接修改位於 ~/.heimdall/config.json 的配置文件，格式與常規 mcpServers 配置 JSON 相同。注意，您不會在 Heimdall 中看到新服務器的工具，除非您還將該服務器和授權工具添加到 ~/.heimdall/controls.json。

編輯授權工具

要為新服務器或現有服務器添加授權工具，請將它們添加到 ~/.heimdall/controls.json 中，Heimdall 會在幾秒鐘後更新其內部配置。如果您的 MCP 客戶端支持工具列表的動態緩存，則應該會看到工具自動更新。如果沒有，請根據需要手動刷新。

示例

在 ~/.heimdall/controls.json 中添加以下內容以授權特定工具：

{
  "authorized_tools": ["tool1", "tool2"]
}

故障排除

工具未顯示

• 確保您已將服務器和工具正確添加到 ~/.heimdall/controls.json
• 檢查是否有拼寫錯誤或格式問題
• 嘗試手動刷新頁面或重新啟動服務

依賴項安裝失敗

• 確保您有穩定的互聯網連接
• 使用管理員權限運行命令
• 檢查 package.json 和 package-lock.json 是否存在

🤝 貢獻

歡迎貢獻。如有任何問題、意見或關注，請聯繫 austin@shinzolabs.com。