README
🚀 @nestr/mcp
Nestr的MCP(模型上下文协议)服务器,可将Claude等AI助手连接到你的工作区。
🚀 快速开始
访问 mcp.nestr.io ,这里有针对Claude Desktop、Claude Code和Cursor的详细分步设置说明。
Claude Desktop
- 前往 设置 → 连接器 → 添加自定义连接器。
- 将 名称 设置为
Nestr,远程MCP URL 设置为https://mcp.nestr.io/mcp。 - 点击“添加”,然后点击“认证”,使用Nestr登录。
Claude Code
claude mcp add nestr --transport http https://mcp.nestr.io/mcp
然后在Claude Code中运行 /mcp 并点击“认证”进行登录。
使用npm包(本地)
如果你想在本地运行MCP服务器:
npx @nestr/mcp
使用以下配置你的AI客户端:
{
"mcpServers": {
"nestr": {
"command": "npx",
"args": ["-y", "@nestr/mcp"],
"env": {
"NESTR_API_KEY": "your-api-key-here"
}
}
}
}
获取API密钥的步骤如下:
- 访问你的 Nestr工作区。
- 点击 设置 → 集成 → 工作区API访问 → 配置。
- 点击 “新API密钥” 并复制它。
✨ 主要特性
此MCP服务器允许AI助手与你的Nestr工作区进行交互:
- 搜索任务、项目和角色
- 创建和更新嵌套项
- 查看组织结构(圈子、角色、职责)
- 获取工作区洞察和指标
- 添加评论并进行协作
💻 使用示例
向你的AI助手询问以下问题:
- "我可以访问哪些工作区?"
- "搜索与营销相关的任务"
- "创建一个名为'第一季度规划'的新项目"
- "我当前的项目有哪些,它们的状态如何?"
- "谁负责客户支持?"
📦 安装指南
本地运行
npx @nestr/mcp
📚 详细文档
可用工具
工作区与搜索
| 工具 | 描述 |
|------|-------------|
| nestr_list_workspaces | 列出可访问的工作区 |
| nestr_get_workspace | 获取工作区详情 |
| nestr_create_workspace | 创建新的工作区(仅支持OAuth) |
| nestr_search | 搜索嵌套项(任务、项目、角色) |
嵌套项(任务、项目、角色)
| 工具 | 描述 |
|------|-------------|
| nestr_get_nest | 获取特定嵌套项的详情 |
| nestr_get_nest_children | 获取子嵌套项 |
| nestr_create_nest | 创建新的嵌套项 |
| nestr_update_nest | 更新嵌套项属性 |
| nestr_delete_nest | 删除嵌套项 |
| nestr_reorder_nest | 相对于另一个嵌套项重新排序 |
| nestr_bulk_reorder | 批量重新排序多个嵌套项 |
评论与讨论
| 工具 | 描述 |
|------|-------------|
| nestr_add_comment | 向嵌套项添加评论 |
| nestr_get_comments | 获取嵌套项上的评论/讨论 |
组织结构
| 工具 | 描述 |
|------|-------------|
| nestr_list_circles | 列出组织圈子 |
| nestr_get_circle | 获取圈子详情 |
| nestr_get_circle_roles | 获取圈子中的角色 |
| nestr_list_roles | 列出所有角色 |
| nestr_list_users | 列出工作区成员 |
| nestr_get_user | 获取用户详情 |
标签与项目
| 工具 | 描述 |
|------|-------------|
| nestr_list_labels | 列出工作区标签 |
| nestr_get_label | 获取标签详情 |
| nestr_get_projects | 列出带有状态的项目 |
洞察与应用
| 工具 | 描述 |
|------|-------------|
| nestr_get_insights | 获取工作区指标 |
| nestr_get_insight_history | 获取指标的历史趋势数据 |
| nestr_get_workspace_apps | 列出已启用的应用/功能 |
个人(仅支持OAuth)
| 工具 | 描述 |
|------|-------------|
| nestr_list_inbox | 列出用户收件箱中的项目 |
| nestr_create_inbox_item | 快速捕获到收件箱 |
| nestr_get_inbox_item | 获取收件箱项目详情 |
| nestr_update_inbox_item | 更新收件箱项目 |
| nestr_reorder_inbox | 重新排序收件箱项目 |
| nestr_list_personal_labels | 列出用户的个人标签 |
| nestr_create_personal_label | 创建个人标签 |
| nestr_get_daily_plan | 获取标记为今天的项目 |
MCP应用(交互式UI)
MCP应用是交互式UI组件,可以嵌入支持它们的MCP客户端(如Claude.ai)中。它们为处理Nestr数据提供了丰富的可视化界面。
可完成列表
资源URI:ui://nestr/completable-list
用于查看和完成任务及项目的交互式列表。
特性:
- 项目显示方框图标,待办事项显示复选框
- 勾选项目以标记为已完成(加删除线)
- 内联编辑标题(自动保存)
- 拖放重新排序
- 显示父路径以提供上下文
- 快速链接以在Nestr中打开项目
用法:当AI助手返回任务或项目结果时,支持的客户端可以渲染此交互式UI而不是纯文本,允许你直接在聊天中完成项目、编辑标题和重新排序。
认证
OAuth(推荐)
mcp.nestr.io 上的托管服务会自动处理OAuth。只需添加服务器并通过浏览器进行认证。
OAuth遵循用户特定的权限 - AI助手只能访问经过认证的用户可以访问的内容。
API密钥
API密钥提供对工作区的完全访问权限,可与本地npm包一起使用。请参阅上面的 快速开始。
注意:API密钥无论用户权限如何都提供对工作区的完全访问权限。
环境变量
认证(必需)
| 变量 | 描述 |
|----------|-------------|
| NESTR_API_KEY | Nestr API密钥(对工作区的完全访问权限) |
| NESTR_OAUTH_TOKEN | OAuth令牌(遵循用户权限) |
- 本地使用时,
NESTR_API_KEY或NESTR_OAUTH_TOKEN是必需的。
配置(可选)
| 变量 | 描述 | 默认值 |
|----------|-------------|---------|
| NESTR_API_BASE | API基础URL | https://app.nestr.io/api |
托管/服务器(仅HTTP传输)
这些变量用于运行托管部署的HTTP服务器时:
| 变量 | 描述 | 默认值 |
|----------|-------------|---------|
| PORT | HTTP服务器端口 | 3000 |
| NESTR_OAUTH_CLIENT_ID | 托管OAuth流程的OAuth客户端ID | - |
| NESTR_OAUTH_CLIENT_SECRET | OAuth客户端密钥 | - |
| OAUTH_ENCRYPTION_KEY | 用于加密静止状态下OAuth会话的32字节Base64密钥 | - |
| GTM_ID | 着陆页的Google Tag Manager容器ID | - |
分析(可选)
服务器端分析选项:
GA4测量协议:
| 变量 | 描述 |
|----------|-------------|
| GA4_MEASUREMENT_ID | GA4测量ID(例如,G-XXXXXXXXXX) |
| GA4_API_SECRET | 测量协议API密钥 |
| GA4_DEBUG | 设置为 true 以验证事件而不记录 |
注意:GA4跟踪需要同时设置 GA4_MEASUREMENT_ID 和 GA4_API_SECRET。如果仅设置了测量ID,则会记录警告并禁用跟踪。
MCPcat(特定于MCP的分析):
| 变量 | 描述 |
|----------|-------------|
| MCPCAT_PROJECT_ID | MCPcat项目ID(来自 mcpcat.io) |
| MCPCAT_ENABLE_REPLAY | 启用会话重放(默认:false) |
开发
# 克隆仓库
git clone https://github.com/nestr-dev/nestr-mcp.git
cd nestr-mcp
# 安装依赖
npm install
# 设置你的API密钥
export NESTR_API_KEY=your-api-key
# 在开发模式下运行(标准输入输出)
npm run dev
# 运行HTTP服务器进行本地测试
npm run dev:http
# 为生产环境构建
npm run build
# 使用MCP检查器进行测试
npm run inspect
安全
- 切勿将你的API密钥或OAuth令牌提交到版本控制中。
- OAuth令牌遵循用户权限,建议使用。
- API密钥提供对工作区的完全访问权限 - 建议使用OAuth以获得更精细的权限控制。
- 如果你怀疑凭据已泄露,请轮换它们。
资源
- 设置指南 - 分步设置说明
- Nestr帮助中心
- Nestr API文档
- 模型上下文协议
📄 许可证
本项目采用MIT许可证,请参阅 LICENSE 了解详细信息。
Scan to join WeChat group