关键词

笔记管理资源管理工具集成LLM上下文本地服务

使用说明

项目简介

convex-mcp-server 是一个使用 TypeScript 开发的 MCP 服务器示例，它演示了如何使用 MCP 协议构建应用后端，并提供了一个简单的笔记系统。通过该服务器，LLM 客户端可以管理和访问文本笔记。

主要功能点

  • 资源 (Resources)：
    • 以 'note://' URI 格式管理和访问文本笔记。
    • 每个笔记包含标题、内容和元数据。
    • 提供纯文本 MIME 类型，方便内容访问。
  • 工具 (Tools)：
    • 'create_note' 工具：用于创建新的文本笔记。
      • 接受标题和内容作为必需参数。
      • 将笔记存储在服务器端。

安装步骤

  1. 安装依赖： 打开终端，导航到仓库根目录，运行以下命令安装项目依赖： 
    npm install
  2. 构建服务器： 运行以下命令构建服务器代码： 
    npm run build
    构建后的服务器文件位于 'build/index.js'。

服务器配置

要将 convex-mcp-server 配置为 MCP 服务器供 MCP 客户端（如 Claude Desktop）使用，您需要编辑客户端的配置文件。以 Claude Desktop 为例，配置文件路径如下：

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

在配置文件中，找到或创建 '"mcpServers"' 字段，并添加 convex-mcp-server 的配置信息。配置信息是一个 JSON 对象，示例如下：

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

配置参数说明：

  • '"convex-mcp-server"': 服务器名称，可以自定义，用于在客户端中标识该服务器。
  • '"command"': 必需。MCP 服务器的启动命令。您需要将 '/path/to/convex-mcp-server/build/index.js' 替换为 'convex-mcp-server' 项目构建输出 'index.js' 文件的绝对路径。

请注意：您需要根据实际情况修改 'command' 字段中的路径，确保指向您本地 'convex-mcp-server' 项目的 'build/index.js' 文件。

基本使用方法

  1. 启动服务器： MCP 服务器不需要手动启动。当 MCP 客户端（如 Claude Desktop）需要连接到该服务器时，会自动根据配置文件中的 'command' 启动服务器进程。

  2. 在 MCP 客户端中使用： 配置完成后，在 MCP 客户端中，您应该能够：

    • 列出由 convex-mcp-server 提供的资源（即笔记列表）。
    • 通过 'note://' URI 访问具体的笔记内容。
    • 调用 'create_note' 工具创建新的笔记。

    具体操作方式取决于您使用的 MCP 客户端的功能和界面。通常，客户端会提供界面来浏览资源、调用工具等。您可以参考 MCP 客户端的文档来了解如何使用配置的 MCP 服务器。

调试

如果需要调试 MCP 服务器，可以使用 MCP Inspector 工具。在项目根目录下运行以下命令：

npm run inspector

MCP Inspector 会提供一个 URL，您可以在浏览器中打开该 URL 来访问调试工具。

信息

分类

生产力应用

访问项目