mcp-guide

🚀 MCP 指南服务器（v0.1.5）

这是一款面向新手的 Model Context Protocol (MCP) 服务器，能帮助用户理解 MCP 概念，提供交互式示例，还会列出可用的 MCP 服务器。它专为与 MCP 打交道的开发者打造，是开发者的实用助手。

🚀 快速开始

MCP 指南服务器旨在为新手提供便捷的 MCP 学习与使用体验。你可以通过简单的安装步骤，快速将其集成到你的工作流程中。

✨ 主要特性

• 📚 概念说明：能获取清晰、面向新手的 MCP 概念解释，涵盖工具、资源、提示等方面。
• 🔍 服务器目录：可浏览按类别整理的全面可用 MCP 服务器列表。
• 💡 交互式示例：查看 MCP 功能的实际应用场景示例。
• 🛠️ 教程提示：有逐步指南，教你创建第一个 MCP 工具和资源。

📦 安装指南

你可以使用以下命令进行安装：

# 使用 npm
npm install -g mcp-guide

# 使用 yarn
yarn global add mcp-guide

💻 使用示例

基础用法

在 Claude Desktop 中使用

1. 将服务器添加到你的 Claude Desktop 配置文件（claude_desktop_config.json）中：

{
  "mcpServers": {
    "mcp-guide": {
      "command": "node",
      "args": ["path/to/mcp-guide/dist/index.js"]
    }
  }
}

2. 重启 Claude Desktop。
3. 使用可用工具：
   • explain_concept：获取 MCP 概念的解释。
   • show_example：查看 MCP 功能的实际示例。
   • list_servers：按类别浏览可用 MCP 服务器。

独立运行

# 启动服务器
mcp-guide

# 或者如果本地安装
npx mcp-guide

高级用法

可用工具详细说明

• explain_concept：获取一个 MCP 概念的清晰解释。 示例概念：

  • tools（工具）
  • resources（资源）
  • prompts（提示）
  • server（服务器）
  • client（客户端）
  • server_types（服务器类型）
  • frameworks（框架）
  • clients（客户端）

• show_example：展示一个 MCP 功能的实际示例。 示例功能：

  • tool_call（工具调用）
  • resource_read（资源读取）
  • prompt_template（提示模板）

• list_servers：按类别列出可用的 MCP 服务器。 类别：

  • browser（浏览器）
  • cloud（云）
  • command_line（命令行）
  • communication（通信）
  • customer_data（客户数据）
  • database（数据库）
  • developer（开发者）
  • data_science（数据分析）
  • filesystem（文件系统）
  • finance（金融）
  • knowledge（知识库）
  • location（位置）
  • monitoring（监控）
  • search（搜索）
  • travel（旅行）
  • version_control（版本控制）
  • other（其他）

🔧 技术细节

开发步骤

# 克隆仓库
git clone https://github.com/qpd-v/mcp-guide.git
cd mcp-guide

# 安装依赖
npm install

# 构建项目
npm run build

# 启动服务器
npm start

🤝 贡献

欢迎贡献！请随时提交 Pull Request。

📄 许可证

本项目采用 Apache License 2.0 许可证，详情见 LICENSE 文件。

🗺️ 发展路线图

• [ ] 从服务器列表实现交互式安装
• [ ] 增加更多交互式示例和教程
• [ ] 改进服务器分类和搜索功能