使用说明
notepm mcp服务器
⚠️ UNOFFICIAL - This is NOT an official NotePM product ⚠️
非官方 模型上下文协议(MCP) 服务器 NotePM -知识管理和文档平台。
该服务器使Claude等AI助手能够搜索、阅读、创建和更新NotePM工作区中的页面。
需求
- Node.js>=24
安装
使用npx(推荐)
无需安装。配置您的MCP客户端以直接运行服务器 npx.
全球安装
npm install -g @nonz250/notepm-mcp-server
配置
克劳德桌面
将以下内容添加到您的Claude Desktop配置文件中:
macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
视窗: %APPDATA%\Claude\claude_desktop_config.json
{
"mcpServers": {
"notepm": {
"command": "npx",
"args": ["-y", "@nonz250/notepm-mcp-server"],
"env": {
"NOTEPM_TEAM_DOMAIN": "your-team-domain",
"NOTEPM_ACCESS_TOKEN": "your-access-token"
}
}
}
}
克劳德代码
使用CLI
claude mcp add notepm \
--env NOTEPM_TEAM_DOMAIN=your-team-domain \
--env NOTEPM_ACCESS_TOKEN=your-access-token \
-- npx -y @nonz250/notepm-mcp-server
使用设置文件
将以下内容添加到您的Claude Code设置文件中(.claude/settings.json 或 .claude/settings.local.json):
{
"mcpServers": {
"notepm": {
"command": "npx",
"args": ["-y", "@nonz250/notepm-mcp-server"],
"env": {
"NOTEPM_TEAM_DOMAIN": "your-team-domain",
"NOTEPM_ACCESS_TOKEN": "your-access-token"
}
}
}
}
Codex CLI
codex mcp add notepm \
--env NOTEPM_TEAM_DOMAIN=your-team-domain \
--env NOTEPM_ACCESS_TOKEN=your-access-token \
-- npx -y @nonz250/notepm-mcp-server
使用全局安装
如果是全局安装,请更换 npx 使用直接命令:
{
"mcpServers": {
"notepm": {
"command": "notepm-mcp-server",
"env": {
"NOTEPM_TEAM_DOMAIN": "your-team-domain",
"NOTEPM_ACCESS_TOKEN": "your-access-token"
}
}
}
}
可用工具
| 工具 | 说明 |
|---|---|
list_folders |
在带有层次结构的注释中列出文件夹 |
list_notes |
列出工作区中的所有笔记 |
search_pages |
按关键字、注释或标签搜索页面 |
get_page |
获取页面的完整内容,包括标题、正文和标签 |
create_page |
在指定注释中创建新页面 |
update_page |
更新现有页面的内容 |
list_tags |
列出工作区中的所有标签 |
create_tag |
创建新标签 |
环境变量
| 变量 | 必填 | 描述 |
|---|---|---|
NOTEPM_TEAM_DOMAIN |
是 | 您的NotePM团队域(例如。, demo 为了 demo.notepm.jp) |
NOTEPM_ACCESS_TOKEN |
是 | 来自NotePM的API访问令牌 |
获取访问令牌
- 登录您的NotePM工作区
- 首选 个人设置 > 访问令牌
- 生成新的访问令牌
- 复制令牌并在配置中使用它
发展
在本地使用MCP服务器
在开发该软件包时, npx @nonz250/notepm-mcp-server 在项目目录中无法工作。请改用本地版本:
claude mcp add notepm \
--env NOTEPM_TEAM_DOMAIN=your-team-domain \
--env NOTEPM_ACCESS_TOKEN=your-access-token \
-- npm run start --prefix /path/to/notepm-mcp-server
codex mcp add notepm \
--env NOTEPM_TEAM_DOMAIN=your-team-domain \
--env NOTEPM_ACCESS_TOKEN=your-access-token \
-- npm run start --prefix /path/to/notepm-mcp-server
设置
git clone https://github.com/nonz250/notepm-mcp-server.git
cd notepm-mcp-server
npm install
npm run build
本地运行
NOTEPM_TEAM_DOMAIN=your-team NOTEPM_ACCESS_TOKEN=your-token npm run start
运行测试
npm test
装订和格式化
npm run lint
npm run format
贡献
欢迎投稿!请参阅 贡献.md 作为指导方针。
许可证
麻省理工学院
