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

Note.com

一个提供Note文章搜索、详情获取和用户文章列表功能的API服务

article

README

🚀 笔记API工具

笔记API工具提供了便捷的文章搜索、详情获取以及用户文章列表获取等功能,能帮助开发者高效地与笔记系统进行交互。

🚀 快速开始

克隆项目

git clone https://github.com/champaya/note-mcp.git

安装依赖

npm i

项目构建

npm run build

✨ 主要特性

  • 搜索文章:可通过关键字搜索文章,还支持指定最大数量和起始位置,满足多样化的搜索需求。
  • 获取文章详情:借助文章 ID 能精准获取特定文章的详细信息。
  • 用户文章获取:通过用户名获取用户的文章列表,并且支持指定每页大小。需注意,这里的用户名是指在您的 notes URL 中指定的值,而非显示的名称。

📦 安装指南

在项目根目录下,按照以下步骤进行配置:

"note-api": {
          "command": "node",
          "args": [
            "/path/absolute/your-repository-root/dist/index.js"
          ]
        }

上述配置中,/path/absolute/your-repository-root 需替换为您项目的实际根目录路径。

help

运行方式说明

cloud

托管运行

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

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

本地运行 / 其它方式

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

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