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 需替换为您项目的实际根目录路径。
微信扫一扫