使用说明

项目简介

本仓库实现了一个简单的MCP（Model Context Protocol）服务器，使用TypeScript和ServiceStack框架构建。它通过一个基础的笔记系统，演示了MCP协议的核心功能，例如资源管理、工具调用和Prompt模板的使用。此服务器旨在帮助开发者理解和实践如何构建符合MCP协议的服务端应用。

主要功能点

资源管理 (Resources):
- 将笔记作为资源进行管理，每个笔记都有唯一的URI（'note://' 协议），并支持以纯文本格式访问笔记内容。
- 允许客户端列出所有可用的笔记资源，并获取每个笔记的元数据（如标题和描述）。
工具执行 (Tools):
- 提供 'create_note' 工具，允许客户端通过提供标题和内容创建新的笔记。
- 工具执行结果以文本形式返回，告知客户端操作是否成功。
Prompt模板 (Prompts):
- 提供 'summarize_notes' Prompt模板，用于生成所有笔记的摘要。
- 在Prompt中，会将所有笔记的内容作为嵌入资源包含进去，以便LLM进行摘要生成。

安装步骤

安装Node.js和npm: 确保你的电脑上已安装Node.js和npm（Node包管理器）。
克隆仓库: 将仓库 'https://github.com/ServiceStack/servicestack-mcp' 克隆到本地。
安装依赖: 在仓库根目录下，打开终端并运行命令 'npm install'，安装项目所需的依赖包。
构建项目: 运行命令 'npm run build'，编译TypeScript代码并生成可执行的JavaScript文件。

服务器配置

要将此MCP服务器与MCP客户端（例如Claude Desktop）一起使用，你需要配置客户端以连接到此服务器。配置信息通常以JSON格式提供，你需要指定服务器的启动命令。以下是配置示例，请根据你的实际文件路径进行调整：

{
  "mcpServers": {
    "@servicestack/mcp": {
      "command": "/path/to/servicestack-mcp/build/index.js"
    }
  }
}

'"command"': 指定服务器启动命令。请将 '/path/to/servicestack-mcp/build/index.js' 替换为你在本地克隆的 'servicestack-mcp' 仓库中 'build/index.js' 文件的绝对路径。

基本使用方法

启动MCP服务器: MCP服务器无需手动启动，当MCP客户端尝试连接到 '@servicestack/mcp' 服务时，客户端会自动根据配置启动服务器。
配置MCP客户端: 根据你的MCP客户端（如Claude Desktop）的指引，将上面提供的服务器配置信息添加到客户端的配置文件中。
使用MCP客户端: 启动并使用你的MCP客户端。客户端应该能够检测到已配置的 '@servicestack/mcp' 服务器，并允许你通过客户端界面或指令，与服务器提供的笔记资源、工具和Prompt进行交互，例如：
- 列出可用的笔记资源。
- 调用 'create_note' 工具创建新笔记。
- 使用 'summarize_notes' Prompt生成笔记摘要。

请注意，具体的使用方式取决于你所使用的MCP客户端的功能和界面。

关键词