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。