使用说明

项目简介

mcp-server-on-raspi 是一个基于 Model Context Protocol (MCP) 的服务器实现,它提供了一个简单的笔记管理系统。通过该服务器,LLM客户端可以访问和操作存储在服务器端的笔记资源,并利用服务器提供的工具和Prompt模板来增强其上下文理解和交互能力。

主要功能点

  • 资源 (Resources)
    • 提供笔记存储功能,每篇笔记都有唯一的 'note://' URI。
    • 允许LLM客户端通过URI访问和读取笔记内容。
  • Prompt 模板 (Prompts)
    • 提供 'summarize-notes' Prompt,用于总结所有已存储的笔记。
    • 支持可选的 'style' 参数(brief/detailed)来控制总结的详细程度。
  • 工具 (Tools)
    • 提供 'add-note' 工具,允许LLM客户端向服务器添加新的笔记。
    • 添加笔记后,服务器会通知客户端资源已更新。

安装步骤

  1. 环境准备:确保你的环境中已安装 Python 和 uv (一个快速的 Python 包安装和管理工具,可以替代 pip)。如果还没有安装 uv,请参考 uv installation 进行安装。

  2. 同步依赖并更新 lockfile

    uv sync
  3. 构建包分发文件

    uv build

    这将在 'dist/' 目录中创建源代码和 wheel 分发文件。

服务器配置

要将 mcp-server-on-raspi 配置为 MCP 服务器供客户端(例如 Claude Desktop)使用,你需要配置客户端的 MCP 服务器设置。以下是针对开发环境的配置示例,你需要将 '/Users/daikiwatanabe/ghq/github.com/daikw/mcp-server-on-raspi' 替换为你实际的项目路径。

MCP客户端配置 (JSON 格式):

{
  "mcpServers": {
    "mcp-server-on-raspi": {  // 服务器名称,客户端用以识别和引用
      "command": "uv",        // 运行服务器的命令,这里使用 uv
      "args": [              // 传递给命令的参数列表
        "--directory",      // 指定工作目录
        "/Users/daikiwatanabe/ghq/github.com/daikw/mcp-server-on-raspi", // 你的 mcp-server-on-raspi 项目的本地路径,**请替换为你的实际路径**
        "run",              // uv 的 run 命令,用于运行 Python 脚本
        "mcp-server-on-raspi" // 要运行的 Python 模块名,对应于项目中的 'mcp_server_on_raspi' 模块
      ]
    }
  }
}

配置说明:

  • '"mcpServers"': MCP客户端配置服务器的顶级字段。
  • '"mcp-server-on-raspi"': 你为这个 MCP 服务器定义的名称,客户端会使用这个名称来引用它。可以自定义,但需要与客户端配置保持一致。
  • '"command"': 指定用于启动 MCP 服务器的命令。这里使用 'uv',假设你的环境中可以使用 'uv' 命令。如果你的环境不同,可能需要调整为 'python3' 或其他合适的命令。
  • '"args"': 一个字符串数组,包含了传递给 'command' 的参数。
    • '"--directory"': 告诉 'uv run' 命令在指定的目录下查找和运行模块。
    • '"/Users/daikiwatanabe/ghq/github.com/daikw/mcp-server-on-raspi"': 请务必替换为你的 'mcp-server-on-raspi' 项目在你的电脑上的绝对路径。 这是服务器代码所在的目录。
    • '"run"': 'uv' 的子命令,用于执行指定的 Python 模块。
    • '"mcp-server-on-raspi"': 指定要运行的 Python 模块的名称。这通常对应于你的项目包名。确保你的项目 'src' 目录下有 'mcp_server_on_raspi' 文件夹,并且其中包含 'init.py' 和 'server.py' 文件。'init.py' 中应该调用 'server.main()' 函数来启动服务器。

如何找到项目路径 (重要):

你需要找到你将 'mcp-server-on-raspi' 仓库克隆到本地的路径。例如,如果你使用 'git clone https://github.com/daikw/mcp-server-on-raspi' 命令,并且在你的用户目录下的 'my_projects' 文件夹中执行了该命令,那么项目路径可能类似于 '/Users/你的用户名/my_projects/mcp-server-on-raspi'。请根据你的实际情况替换上述配置中的路径。

将配置应用到客户端 (以 Claude Desktop 为例):

  1. 找到 Claude Desktop 的配置文件 'claude_desktop_config.json'。

    • MacOS: '~/Library/Application\ Support/Claude/claude_desktop_config.json'
    • Windows: '%APPDATA%/Claude/claude_desktop_config.json'
  2. 打开 'claude_desktop_config.json' 文件。

  3. 在 JSON 结构中找到 '"mcpServers"' 部分。如果不存在,则手动创建。

  4. 将上述 JSON 配置代码片段添加到 '"mcpServers"' 中。

  5. 保存 'claude_desktop_config.json' 文件并重启 Claude Desktop。

基本使用方法

  1. 启动 MCP 服务器 (配置客户端后,客户端通常会自动启动服务器,或者根据客户端的配置手动启动)。
  2. 在支持 MCP 协议的 LLM 客户端中 (例如 Claude Desktop),客户端应该能够检测到你配置的 'mcp-server-on-raspi' 服务器。
  3. 通过客户端界面,你可以:
    • 使用 'summarize-notes' Prompt 来总结当前的笔记。
    • 使用 'add-note' 工具来添加新的笔记。
    • 客户端可以列出和读取 'note://' URI 格式的笔记资源。

注意: 此使用说明基于仓库提供的 README 和代码进行推断,具体使用方式可能因客户端软件而异。请参考你使用的 MCP 客户端的文档以获取更详细的客户端操作指南。

信息

分类

生产力应用