MCP-Server-Inbox

MCP服务对接InBox Notes API，实现通过任何MCP客户端创建对话格式的笔记的功能。

功能介绍

• 访问inBox Notes API
• 提供MCP服务发现接口
• 支持通过MCP客户端创建笔记
• 支持设置笔记标题（可选）
• 支持Inspector调试工具

预置条件

• Node.js 18+
• InBox Note API（专业功能）
• 支持MCP协议的客户端（如Cursor AI）

安装与使用

方法1：使用NPX运行

# 运行服务
npx mcp-server-inbox --inbox_user_token=https://inbox.gudong.site/api/inbox/your_token_here

# 使用环境变量
INBOX_USER_TOKEN=https://inbox.gudong.site/api/inbox/your_token_here npx mcp-server-inbox

方法2：本地构建

1. 克隆代码仓库

git clone https://github.com/maoruibin/mcp-server-inbox.git
cd mcp-server-inbox

2. 安装依赖

npm install

3. 构建

npm run build

4. 运行服务

# 运行服务
node build/index.js --inbox_user_token=https://inbox.gudong.site/api/inbox/your_token_here

# 使用环境变量
INBOX_USER_TOKEN=https://inbox.gudong.site/api/inbox/your_token_here node build/index.js

调试与开发

使用Inspector

该项目内置了MCP Inspector工具，可以帮助调试和监控服务运行状态：

npm run inspector

运行后，可以在浏览器中访问http://localhost:5173查看服务操作状态和调试信息。

在MCP客户端中的配置

Cursor AI

1. 打开Cursor的MCP服务配置文件（通常位于）~/.cursor/mcp.json
2. 添加MCP服务inbox的配置：

{
  "mcpServers": {
    "mcp-server-inbox": {
      "command": "npx",
      "args": [
        "mcp-server-inbox"
      ],
      "env": {
        "INBOX_USER_TOKEN": "your api path"
      }
    }
  }
}

其他MCP客户端

请参考相应MCP客户端的配置文档并添加类似的配置信息。

使用示例

在支持MCP的客户端中，可以使用自然语言与AI交流来创建笔记：

• 记录：今天我学习了MCP开发
• 请帮我记笔记，标题是“TypeScript学习”：高级TypeScript类型包括Partial、Required、Pick等
• 写入inBox：项目文档需要明天完成

API描述

write_note

• 描述：将笔记内容写入inBox
• 参数
  • Title：笔记标题（可选）
  • Content：笔记内容（Markdown格式），最多3000字符
• 返回值：
  • 成功：返回一个包含成功信息的对象
  • 失败：抛出相应的错误信息

InBox API描述

本项目依赖于inBox的API服务，具体如下：

接口

• API端点：https://app.gudong.site/api/inbox/${userToken}
• 请求方法：POST
• Content-Type：application/json
• 请求频率：每天最多50次

请求参数

参数	类型	必填	描述
Title	string	否	笔记标题
Content	string	是	笔记内容，最多3000字符

使用示例

1. 创建普通笔记：

npx mcp-server-inbox --inbox_user_token=https://inbox.gudong.site/api/inbox/your_token_here

2. 创建带有标题的笔记：

# 在对话中指定标题
"帮我记笔记，标题是「TypeScript学习」：TypeScript 的高级类型包括 Partial、Required、Pick 等"

响应格式

{
  "code": 0,
  "msg": "已提交，请打开inBox查看笔记"
}

解释：代码0表示请求成功，非零状态表示失败

图片支持

inBox API支持解析Markdown格式的图片标签。您可以在笔记内容中添加Markdown格式的图片链接，例如：

今天天气很好，![](https://example.com/image.jpg)

注意：API不支持直接上传图片。您需要先将图片上传到图床，然后使用图片链接

更多详细的API信息，请参阅：InBox API文档

处理逻辑

当用户通过MCP客户端发送创建笔记的请求时，服务将按照以下逻辑处理：

1. 分析用户输入，识别标题（如果有）和内容
2. 调用inBox API，并直接传递title和content两个参数
3. 返回处理结果和笔记内容摘要

用户可以在对话中明确指定标题，例如：“帮我记笔记，标题是‘TypeScript学习’：这是内容”。服务会自动提取标题部分。

限制说明

• inBox API请求频率限制为每天最多50次
• 笔记内容支持的最大长度为3000字符
• 需要InBox PRO用户才能使用API功能

获取inBox API配置

1. 打开inBox应用
2. 前往【设置】->【账户】->【API】
3. 获取您的专属API配置信息

贡献指南

欢迎提交Issue和Pull Requests以帮助改进此项目。在提交PR之前，请确保：

1. 代码通过TypeScript编译
2. 所有功能均已测试
3. 更新相关文档

更新日志

v0.1.0

• 初始版本发布
• 支持基本的笔记创建功能
• 支持两种配置方式：Token和完整URL
• 添加Inspector调试工具支持

作者

gudong - 个人主页

相关项目

• inBox -简单易用的笔记服务
• MCP Protocol - 模型上下文协议规范

许可证

MIT