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

mcp-state-server

一个基于TypeScript的MCP服务器,实现了简单的笔记系统,包含资源管理、笔记创建和摘要生成功能。

article

README

🚀 状态服务器 MCP 服务器

这是一个基于 TypeScript 的 MCP 服务器,实现了简单的笔记系统。它通过 note:// URI 列出和访问笔记资源,提供创建新笔记的工具,还能生成所有存储笔记的摘要,以此演示核心的 MCP 概念。

🚀 快速开始

本状态服务器 MCP 服务器实现了简单笔记系统,你可以通过以下方式快速上手,体验其核心功能。

✨ 主要特性

资源

  • 可通过 note:// URI 列举和访问笔记。
  • 每个笔记都包含标题、内容和元数据。
  • 采用简单的纯文本 MIME 类型进行内容访问。

工具

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

提示

  • summarize_notes:生成所有存储笔记的摘要。
    • 包含所有笔记内容作为嵌入资源。
    • 返回结构化的提示以供 LLM 进行总结。

📦 安装指南

开发环境依赖安装

npm install

服务器构建

npm run build

带有自动重建功能的开发

npm run watch

与 Claude 桌面一起使用的配置

要与 Claude 桌面一起使用,请添加服务器配置:

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

调试

由于 MCP 服务器通过标准输入输出进行通信,调试可能具有挑战性。我们推荐使用 MCP Inspector,它作为包脚本可用:

npm run inspector

Inspector 将提供访问浏览器中的调试工具的 URL。

💻 使用示例

基础用法

# 安装依赖
npm install
# 构建服务器
npm run build
# 带有自动重建功能的开发
npm run watch

高级用法

# 与 Claude 桌面一起使用时,在配置文件中添加服务器配置
{
  "mcpServers": {
    "state-server": {
      "command": "/path/to/state-server/build/index.js"
    }
  }
}
# 使用 MCP Inspector 进行调试
npm run inspector
help

运行方式说明

cloud

托管运行

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

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

本地运行 / 其它方式

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

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