fp-mcp MCP 服务器使用说明

项目简介

fp-mcp 是一个使用 TypeScript 构建的 MCP 服务器示例,它实现了一个简单的笔记应用。该服务器旨在演示 Model Context Protocol (MCP) 的核心概念,例如资源管理、工具调用和 Prompt 模板的使用。通过 fp-mcp,您可以了解如何构建一个 MCP 服务器,并将其与支持 MCP 协议的 LLM 客户端(如 Claude Desktop)集成。

主要功能点

  • 资源 (Resources):
    • 提供笔记资源,每个笔记可以通过唯一的 'note://' URI 进行访问。
    • 允许客户端列出所有可用的笔记资源。
    • 每个笔记资源包含标题、内容和元数据,并以纯文本格式提供内容。
  • 工具 (Tools):
    • 提供 'create_note' 工具,允许客户端创建新的文本笔记。
    • 创建笔记工具需要提供笔记的标题和内容作为输入。
  • Prompt 模板 (Prompts):
    • 提供 'summarize_notes' Prompt 模板,用于生成所有笔记内容的摘要。
    • 该 Prompt 模板会将服务器中存储的所有笔记内容作为上下文信息提供给 LLM。

安装步骤

  1. 安装 Node.js 和 npm: 确保您的电脑上已经安装了 Node.js 和 npm 包管理器。
  2. 克隆仓库: 使用 git 命令克隆 fp-mcp 仓库到本地:
    git clone https://github.com/jchris/fp-mcp.git
    cd fp-mcp
  3. 安装依赖: 在仓库目录下运行以下命令安装项目所需的依赖包:
    npm install
  4. 构建服务器: 运行以下命令编译 TypeScript 代码并生成 JavaScript 服务器文件:
    npm run build
    构建成功后,服务器程序 'index.js' 将位于 'build' 目录下。

服务器配置

要将 fp-mcp 服务器与 MCP 客户端连接,您需要在 MCP 客户端的配置文件中指定服务器的启动命令。以 Claude Desktop 为例,您需要在 'claude_desktop_config.json' 文件中添加如下配置:

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

配置参数说明:

  • 'command': 指向服务器启动脚本的路径。请将 '/path/to/fp-mcp/build/index.js' 替换为 'fp-mcp/build/index.js' 文件在您电脑上的绝对路径

注意: 请根据您使用的 MCP 客户端,查阅其文档以确定正确的配置文件位置和格式。

基本使用方法

  1. 启动服务器: 当 MCP 客户端启动时,如果配置正确,fp-mcp 服务器通常会自动启动。您也可以在终端中手动运行 'build/index.js' 文件来启动服务器。
  2. 使用 MCP 客户端功能: 启动客户端后,您可以使用服务器提供的功能。例如,您可以指示客户端调用 'create_note' 工具来创建新的笔记,或者使用 'summarize_notes' Prompt 模板来总结已有的笔记。具体操作方式取决于 MCP 客户端的功能和界面。

调试

如果需要调试 MCP 服务器,可以使用仓库提供的 MCP Inspector 工具。运行 'npm run inspector' 命令可以启动 Inspector,并通过浏览器访问提供的调试页面。

信息

分类

生产力应用