🚀 GitHub 服务器 MCP 服务端
这是一个基于 TypeScript 的 MCP 服务器，实现了简单的笔记系统。它能很好地演示 MCP 的核心概念，如利用 note:// URI 访问和管理笔记，创建新笔记，以及生成所有存储笔记的摘要等，为开发者理解和运用 MCP 提供了实用示例。
🚀 快速开始
本 MCP 服务器实现了简单笔记系统，通过它可以快速了解 MCP 的核心概念。下面为你介绍启动服务器的步骤。
开发环境准备
- 安装依赖：
npm install
- 构建服务器：
npm run build
- 带有自动重建功能的开发：
npm run watch
安装到 Claude Desktop
要在 Claude Desktop 上使用，请在配置文件中添加以下内容：
- 在 MacOS 上：
~/Library/Application Support/Claude/claude_desktop_config.json - 在 Windows 上：
%APPDATA%/Claude/claude_desktop_config.json
{
"mcpServers": {
"github-server": {
"command": "/path/to/github-server/build/index.js"
}
}
}
调试
由于 MCP 服务器通过标准输入输出进行通信，调试可能具有挑战性。我们推荐使用 MCP Inspector，它可以通过包命令运行：
npm run inspector
Inspector 将提供一个 URL，用于在浏览器中访问调试工具。
✨ 主要特性
资源
- 可列出并通过
note://URI 访问笔记，每个笔记包含标题、内容和元数据。 - 使用纯文本 MIME 类型进行简单的内容访问。
工具
create_note- 创建新的文本笔记：- 接受标题和内容作为必填参数。
- 将笔记存储在服务器状态中。
提示
summarize_notes- 生成所有存储笔记的摘要：- 包含所有笔记内容作为嵌入资源。
- 返回结构化的提示，用于 LLM 摘要生成。
📦 安装指南
要在 Claude Desktop 上使用该服务端，需在对应系统的配置文件中添加特定内容：
- MacOS：在
~/Library/Application Support/Claude/claude_desktop_config.json文件中添加。 - Windows：在
%APPDATA%/Claude/claude_desktop_config.json文件中添加。
配置内容如下：
{
"mcpServers": {
"github-server": {
"command": "/path/to/github-server/build/index.js"
}
}
}
💻 使用示例
基础用法
以下是启动服务器的基本命令：
# 安装依赖
npm install
# 构建服务器
npm run build
高级用法
在开发过程中，可使用自动重建功能：
# 带有自动重建功能的开发
npm run watch
另外，调试时可使用 MCP Inspector：
# 运行 MCP Inspector
npm run inspector