JinDaGe - mcpgod MCP Details

article

README

🚀 MCPGod 中文文档

MCPGod 是一款强大的命令行工具，专为开发者高效管理 MCP 服务器而设计。它提供了便捷的操作界面，能让您轻松完成添加、运行、列出服务器等操作，并且支持 Windows、macOS 和 Linux 系统。

🚀 快速开始

MCPGod 是一款命令行工具，可帮助开发者高效管理 MCP 服务器。它支持多系统，操作便捷，能满足多种服务器管理需求。

✨ 主要特性

客户端管理：可添加、移除和列出特定客户端的 MCP 服务器。
工具发现：能查看任意 MCP 服务器上的所有可用工具。
工具调用：可直接从命令行运行任意 MCP 服务器上的工具。
权限控制：能设置或限制特定客户端对某些工具的访问权限。
日志记录：会记录每个客户端每次运行服务器的日志，包含时间戳和清晰的输出，方便调试。

📦 安装指南

使用 npm 全局安装

使用以下命令全局安装 MCPGod：

npm install -g mcpgod

验证安装是否成功：

god --version

通过 npx 直接运行

也可以直接通过 npx 运行：

npx -y mcpgod

💻 使用示例

基础用法

通过命令 god（或 npx -y mcpgod）访问 CLI。以下是一些常用示例：

将服务器添加到客户端 将 MCP 服务器添加到特定客户端（例如 Claude）：

god add @modelcontextprotocol/server-everything -c claude

为客户端指定特定工具 添加服务器时仅配置部分工具：

god add @modelcontextprotocol/server-everything -c claude --tools=echo,add

列出客户端的服务器 查看某个客户端的所有已配置服务器：

god list -c claude

移除服务器 从客户端配置中移除特定 MCP 服务器：

god remove @modelcontextprotocol/server-everything -c claude

运行服务器 启动指定客户端的 MCP 服务器：

god run -c claude

📚 详细文档

日志记录

所有日志文件存储在 ~/.config/mcpgod/logs 目录下，按日期分类组织。

开发指南

MCPGod 使用 Oclif 框架开发。要开始本地开发，请执行以下步骤：

git clone https://github.com/your-repository.git
cd mcpgod
npm install

贡献指南

欢迎参与项目！请按照以下步骤贡献代码：

叉取仓库

git clone https://github.com/your-repository.git
cd mcpgod

创建新分支 为新功能或修复创建独立的分支：

git checkout -b feature/your-feature-name

提交更改 提交您的修改：

git add .
git commit -m "描述您所做的变更"
git push origin feature/your-feature-name

创建 Pull Request 在 GitHub 上为您的分支提交 Pull Request，详细说明变更内容。

📄 许可证

本项目采用 MIT License 许可证。

mcpgod