返回 MCP 目录
public公开dns本地运行

convex-mcp-server

一个基于TypeScript的MCP服务器,实现了简单的笔记系统,提供笔记资源和创建工具。

article

README

🚀 凸面 MCP 服务器

这是一个基于 TypeScript 构建的 MCP 服务器,实现了一个简易的笔记系统。该系统借助以下功能,生动展示了核心的 MCP 概念:

  • 资源:可通过 note:// URI 列出并访问带有标题、内容和元数据的文本笔记。
  • 工具:提供用于创建新笔记的 create_note 工具。

✨ 主要特性

资源

  • 支持通过 note:// URI 列出和访问笔记。
  • 每篇笔记包含标题、内容和元数据。
  • 采用 plain text MIME 类型,实现简单的内容访问。

工具

  • create_note:用于创建新的文本笔记。
    • 需传入标题和内容作为必填参数。
    • 可将笔记存储到服务器状态中。

📦 安装指南

开发环境依赖安装

npm install

服务器构建

npm run build

带有自动重建功能的开发模式

npm run watch

在 Claude Desktop 上的安装

要在 Claude Desktop 上使用,请添加以下服务器配置:

  • 在 MacOS 上:~/Library/Application Support/Claude/claude_desktop_config.json
  • 在 Windows 上:%APPDATA%/Claude/claude_desktop_config.json%
{
  "mcpServers": {
    "convex-mcp-server": {
      "command": "/path/to/convex-mcp-server/build/index.js"
    }
  }
}

💻 使用示例

基础用法

由于原文档未提供基础用法的代码示例,暂无法展示。

高级用法

由于原文档未提供高级用法的代码示例,暂无法展示。

🔧 技术细节

调试

由于 MCP 服务器通过标准输入输出进行通信,调试可能会比较困难。我们推荐使用 MCP Inspector,这是一个可以通过命令运行的工具:

npm run inspector

Inspector 将提供一个可以在浏览器中访问调试工具的 URL。

help

运行方式说明

cloud

托管运行

托管运行通常表示这个 MCP Server 由服务方环境承载,用户一般按页面提供的连接方式或授权流程接入,不需要在本地长期启动一个 MCP 进程

  1. 打开服务方连接页
  2. 完成授权或复制端点
  3. 在 MCP 客户端中连接
terminal

本地运行 / 其它方式

本地运行通常需要用户在自己的电脑或服务器上安装依赖,把 server_config 复制到 MCP 客户端,并按 env_schema 补齐环境变量、密钥或其它配置

  1. 复制 server_config
  2. 安装所需依赖
  3. 补齐环境变量后重启客户端