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

handfuloflight_convex-mcp-server

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

article

README

🚀 凸形 MCP 服务器

这是一个基于 TypeScript 的 MCP 服务器,实现了简单的笔记系统。它通过资源表示与工具创建,演示了核心的 MCP 概念,为笔记管理提供了便捷的解决方案。

🚀 快速开始

本服务器基于 TypeScript 构建,实现了一个简单的笔记系统,通过资源表示和工具创建,演示了核心 MCP 概念。

✨ 主要特性

资源

  • 可通过 note:// URI 列表和访问笔记。
  • 每个笔记都具备标题、内容和元数据。
  • 使用纯文本 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. 补齐环境变量后重启客户端