JinDaGe - mcp-server-inbox MCP Details

article

README

🚀 MCP-Server-Inbox 中文版

MCP 服务与 inBox 笔记 API 对接，可让任意 MCP 客户端以对话形式创建笔记，极大提升了笔记创建的便捷性。

✨ 主要特性

接入 inBox 笔记 API，实现与笔记服务的无缝对接。
提供 MCP 服务发现接口，方便服务的查找与使用。
支持通过 MCP 客户端创建笔记，操作简单便捷。
支持设置笔记标题（可选），满足多样化的笔记记录需求。
支持 Inspector 调试工具，便于实时监控和调试服务运行状态。

📦 安装指南

前置条件

Node.js 18+
inBox 笔记 API (PRO 功能)
支持 MCP 协议的客户端

安装方法

使用以下命令安装项目：

npm install mcp-server-inbox

配置方式

项目支持两种配置方式：

Token 配置：在环境变量中设置 INBOX_TOKEN。
完整 URL 配置：在环境变量中设置 INBOX_API_URL。

💻 使用示例

启动服务

通过以下命令启动 MCP 服务器：

node index.js

基础用法

用户可以在 MCP 客户端中输入如下内容创建笔记：

帮我记笔记，标题是「我的第一个笔记」：这是笔记内容...

服务将自动提取标题和内容，并调用 inBox API 创建笔记。

📚 详细文档

API 说明

请求格式

POST /api/note HTTP/1.1
Content-Type: application/json

{
    "title": "string",
    "content": "string"
}

响应格式

{
    "code": integer,
    "message": string
}

示例响应：

{
    "code": 0,
    "message": "笔记创建成功"
}

处理逻辑

解析用户输入，识别标题和内容。
调用 inBox API 创建笔记。
返回处理结果。

调试工具

项目内置 Inspector 调试工具，支持实时监控和调试服务运行状态。具体使用方法请参考文档。

获取 API 配置

打开 inBox 应用。
进入【设置】 -> 【账户】 -> 【API】。
获取专属的 API 配置信息。

🔧 技术细节

注意事项

每天最多支持 50 条笔记创建。
笔记内容不超过 3000 字符。
需要 inBox PRO 用户身份才能使用 API 功能。

贡献指南

欢迎提交 Issue 和 Pull Request。在提交 PR 前，请确保：

代码通过 TypeScript 编译。
所有功能经过测试。
文档更新及时。

更新日志

v0.1.0

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

作者信息

gudong - 个人主页

📄 许可证

MIT

mcp-server-inbox