dice-server 使用说明

项目简介

dice-server 是一个使用 TypeScript 开发的 MCP 服务器，它演示了 MCP 协议的核心概念，例如资源 (Resources)、工具 (Tools) 和 Prompt 模板 (Prompts)。该服务器实现了一个简单的笔记系统，允许客户端通过 MCP 协议管理文本笔记。

主要功能点

资源 (Resources):
- 将文本笔记作为资源进行管理，可以通过 'note://' URI 访问和列出笔记。
- 每个笔记包含标题、内容和元数据。
- 提供纯文本 MIME 类型来访问笔记内容。
工具 (Tools):
- 提供 'create_note' 工具，允许客户端创建新的文本笔记。
- 'create_note' 工具接受标题和内容作为必需参数，并将笔记存储在服务器内存中。
Prompt 模板 (Prompts):
- 提供 'summarize_notes' Prompt 模板，用于生成所有笔记的摘要。
- 'summarize_notes' Prompt 模板会将所有笔记内容作为嵌入资源包含在 Prompt 中，以便 LLM 进行总结。

安装步骤

安装依赖: 确保已安装 Node.js 和 npm，然后导航到仓库根目录并运行以下命令安装项目依赖：
```
npm install
```
构建服务器: 运行以下命令构建 TypeScript 服务器代码：
```
npm run build
```

服务器配置

要将 dice-server 集成到 MCP 客户端（例如 Claude Desktop），您需要配置客户端以连接到该服务器。以下是 Claude Desktop 的配置示例，您需要将配置信息添加到 'claude_desktop_config.json' 文件中。

MacOS: '~/Library/Application Support/Claude/claude_desktop_config.json' Windows: '%APPDATA%/Claude/claude_desktop_config.json'

{
  "mcpServers": {
    "dice-server": {
      "command": "/path/to/dice-server/build/index.js" // 将 "/path/to/dice-server/build/index.js" 替换为 dice-server 构建后 index.js 文件的实际绝对路径
    }
  }
}

配置参数说明:

'server name': 'dice-server' - 服务器在 MCP 客户端中显示的名称，可以自定义。
'command': '/path/to/dice-server/build/index.js' - 必须修改。指向 dice-server 服务器启动脚本 'index.js' 文件的绝对路径。您需要根据 dice-server 仓库在您本地文件系统中的位置，将 '/path/to/dice-server/build/index.js' 替换为实际的路径。

基本使用方法

启动 dice-server: 在 dice-server 仓库根目录下，构建成功后，通过配置 Claude Desktop 或其他 MCP 客户端来启动服务器。Claude Desktop 会在启动时尝试连接配置的 MCP 服务器。
使用 MCP 客户端与 dice-server 交互: 一旦客户端成功连接到 dice-server，您就可以使用客户端的功能来与服务器交互，例如：
- 列出笔记: 客户端可以请求列出 dice-server 提供的笔记资源。
- 读取笔记: 客户端可以根据笔记的 URI 读取特定笔记的内容。
- 创建笔记: 客户端可以调用 'create_note' 工具，通过提供标题和内容来创建新的笔记。
- 总结笔记: 客户端可以调用 'summarize_notes' Prompt 模板，请求 dice-server 生成所有笔记的摘要。

具体操作方式取决于您使用的 MCP 客户端的功能和界面。通常，客户端会提供界面来浏览资源、调用工具和使用 Prompt 模板。

调试

如果需要调试 dice-server，可以使用 MCP Inspector 工具。按照 README.md 中的说明运行 'npm run inspector' 启动 Inspector，并通过浏览器访问提供的 URL 进行调试。

关键词