inkdropapp_mcp-server

🚀 墨滴 MCP 服务器

墨滴 MCP 服务器是专为 Inkdrop Local HTTP Server API 设计的 Model Context Protocol 服务器，为相关数据访问和操作提供支持。

🚀 快速开始

本服务器为基于 Inkdrop Local HTTP Server API 的 Model Context Protocol 服务器，可助力数据交互与管理。

📦 安装指南

1. 设置本地 HTTP 服务器
2. 将服务器配置添加到 Claude 桌面：
   • MacOS: ~/Library/Application Support/Claude/claude_desktop_config.json
   • Windows: %APPDATA%\Claude\claude_desktop_config.json

{
  "mcpServers": {
    "inkdrop": {
      "command": "npx",
      "args": ["-y", "@inkdropapp/mcp-server"],
      "env": {
        "INKDROP_LOCAL_SERVER_URL": "http://localhost:19840",
        "INKDROP_LOCAL_USERNAME": "your-local-server-username",
        "INKDROP_LOCAL_PASSWORD": "your-local-server-password"
      }
    }
  }
}

✨ 主要特性

工具

1. read-note：根据笔记 ID 从数据库中精准检索笔记的完整内容。
   • 必要输入：
     • noteId：笔记的 ID，可在笔记文档中找到，始终以 note: 开头。
2. search-notes：列出包含给定关键词的所有笔记。
   • 必要输入：
     • keyword：要搜索的关键词。
   • 备注：结果包含截断的笔记正文（最多 200 字符），如需完整内容可使用 read-note。同时支持高级搜索限定符，如 book:、tag:、status:、title: 等。
3. list-notes：在指定笔记本中列出所有笔记。
   • 必要输入：
     • bookId：笔记本 ID，必须以 book: 开头或为 trash。
   • 可选输入：
     • tagIds：用于过滤的标签 ID 数组，每个都以 tag: 开头。
     • keyword：用于过滤笔记的关键词。
     • sort：排序字段（updatedAt、createdAt 或 title），默认值为 updatedAt。
     • descending：反转输出顺序，默认值为 true。
   • 备注：结果包含截断的笔记正文（最多 200 字符），使用 read-note 可获取完整内容。
4. create-note：在数据库中创建一个新的笔记。
   • 必要输入：
     • bookId：笔记本 ID，必须以 book: 开头或为 trash。
     • title：笔记标题。
     • body：笔记内容的 Markdown 格式。
   • 可选输入：
     • status：笔记状态（none、active、onHold、completed、dropped）。
5. update-note：更新数据库中的现有笔记。
   • 必要输入：
     • _id：笔记 ID，必须以 note: 开头。
     • _rev：版本控制令牌（CouchDB MVCC 标识符）。
     • bookId：笔记本 ID，必须以 book: 开头或为 trash。
     • title：笔记标题。
     • body：笔记内容的 Markdown 格式。
   • 可选输入：
     • status：笔记状态（none、active、onHold、completed、dropped）。
6. list-notebooks：检索所有笔记本的列表。
7. list-tags：检索所有标签的列表。

🔧 调试指南

由于 MCP 服务器通过标准输入输出运行，调试可能具有一定挑战性。为了获得最佳调试体验，我们强烈推荐使用 MCP 检查器。

您可以通过以下命令使用 npm 启动检查器：

npx @modelcontextprotocol/inspector

将 http://localhost:19840 复制并粘贴到检查器的 URL 字段中，然后点击 Connect。检查器将显示有关正在运行的 MCP 服务器的详细信息，并提供交互式界面来测试和调试工具。

📚 详细文档

完整的 API 文档可以在 GitHub 上找到。

🤝 贡献者

• [your GitHub username]

感谢您使用 Inkdrop 的 MCP 服务器！