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

mcp_server_opensearch

一个实现简单笔记存储系统的MCP服务器项目,提供笔记URI访问、汇总提示和添加工具功能

article

README

🚀 MCP 服务器 OpenSearch 版本

这是一个基于 MCP 协议的简单服务器项目,实现了笔记存储系统,提供提示语句和工具,可方便地管理笔记资源。

🚀 快速开始

📦 安装指南

使用 Claude Desktop

在 MacOS 上:~/Library/Application\ Support/Claude/claude_desktop_config.json 在 Windows 上:%APPDATA%/Claude/claude_desktop_config.json%

开发/未发布的服务器配置 ``` "mcpServers": { "mcp-server-opensearch": { "command": "uv", "args": [ "--directory", "/Users/gowtham/Gowtham/Projects/mcp-server-opensearch", "run", "mcp-server-opensearch" ] } } ```
已发布的服务器配置 ``` "mcpServers": { "mcp-server-opensearch": { "command": "uvx", "args": [ "mcp-server-opensearch" ] } } ```

✨ 主要特性

🔍 资源

该服务器实现了一个简单的笔记存储系统,具备以下功能:

  • 自定义 note:// URI 方案,可用于访问单个笔记。
  • 每个笔记资源包含名称、描述和 text/plain MIME 类型。

💬 提示语句

该服务器提供一个提示语句:

  • summarize-notes:创建所有存储笔记的摘要。
    • 可选“风格”参数来控制详细程度(简洁/详细)。
    • 根据风格偏好生成包含所有当前笔记内容的提示语句。

🛠️ 工具

该服务器实现了一个工具:

  • add-note:向服务器添加新的笔记。
    • 接受“名称”和“内容”作为必填字符串参数。
    • 更新服务器状态并通知客户端资源更改。

🔧 技术细节

构建和发布

为了准备分发包,可按以下步骤操作:

  1. 同步依赖项并更新锁定文件:
uv sync
  1. 构建包分发版本:
uv build

这将在 dist/ 目录下创建源代码和 wheel 分发版本。

  1. 发布到 PyPI:
uv publish

⚠️ 重要提示

发布到 PyPI 时,您需要通过环境变量或命令行参数设置 PyPI 凭证:

  • 令牌:--tokenUV_PUBLISH_TOKEN
  • 或者用户名/密码:--username/UV_PUBLISH_USERNAME--password/UV_PUBLISH_PASSWORD

调试

由于 MCP 服务器通过标准输入输出运行,调试可能会比较困难。为了获得最佳的调试体验,我们强烈推荐使用 MCP Inspector

您可以通过以下命令启动 MCP Inspector(假设已安装 npm):

npx @modelcontextprotocol/inspector uv --directory /Users/gowtham/Gowtham/Projects/mcp-server-opensearch run mcp-server-opensearch

启动后,Inspector 会显示一个 URL,您可以在浏览器中访问该 URL 开始调试。

help

运行方式说明

cloud

托管运行

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

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

本地运行 / 其它方式

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

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