关键词

Inkdrop笔记应用知识管理开发者工具本地知识库

Inkdrop MCP Server 使用说明

项目简介

Inkdrop MCP Server 是一个基于 Model Context Protocol (MCP) 构建的服务器，它作为 Inkdrop 笔记应用的后端，允许大型语言模型 (LLM) 客户端安全、标准化地访问和操作 Inkdrop 中的笔记数据。通过该服务器，LLM 可以检索笔记内容、搜索笔记、创建新笔记以及获取笔记本列表，从而实现更智能的笔记应用集成和知识管理。

主要功能点

  • 检索笔记内容 (read-note): 根据笔记ID获取完整的笔记内容。
  • 搜索笔记 (search-notes): 根据关键词搜索包含特定内容的笔记列表，支持多种高级搜索语法，例如按笔记本、标签、状态、标题或正文内容进行筛选。
  • 创建笔记 (create-note): 在指定的笔记本中创建新的笔记，可以设置标题、正文内容和状态。
  • 更新笔记 (update-note): 更新已存在的笔记内容，包括笔记本、标题、正文和状态。
  • 列出笔记本 (list-notebooks): 获取Inkdrop中所有笔记本的列表。

安装步骤

  1. 安装 Inkdrop 本地 HTTP 服务器: 首先，您需要安装并配置 Inkdrop 应用程序的本地 HTTP 服务器 API。请参考 Inkdrop 官方文档 完成本地 HTTP 服务器的设置。确保本地 HTTP 服务器可以访问，并且您拥有用户名和密码。

  2. 配置 MCP 服务器到 MCP 客户端: 以 Claude Desktop 为例，您需要编辑 Claude 的配置文件 'claude_desktop_config.json'，添加 Inkdrop MCP Server 的配置信息。

    • macOS: '~/Library/Application Support/Claude/claude_desktop_config.json'
    • Windows: '%APPDATA%\Claude\claude_desktop_config.json'

    将以下 JSON 配置添加到 'claude_desktop_config.json' 文件的 '"mcpServers"' 字段中。如果不存在 '"mcpServers"' 字段，请手动创建。

    {
  "mcpServers": {
    "inkdrop": {
      "command": "npx",
      "args": [
        "-y",
        "@inkdropapp/mcp-server"
      ],
      "env": {
        "INKDROP_LOCAL_SERVER_URL": "http://localhost:19840",  // Inkdrop 本地 HTTP 服务器的 URL，请根据您的实际配置修改
        "INKDROP_LOCAL_USERNAME": "your-local-server-username", // Inkdrop 本地 HTTP 服务器的用户名，请替换为您的用户名
        "INKDROP_LOCAL_PASSWORD": "your-local-server-password"  // Inkdrop 本地 HTTP 服务器的密码，请替换为您的密码
      }
    }
  }
}

    配置参数说明:

    • '"inkdrop"': 服务器名称，您可以自定义，用于在 MCP 客户端中标识该服务器。
    • '"command": "npx"': 启动服务器的命令，这里使用 'npx' 来运行 npm 包。
    • '"args": ["-y", "@inkdropapp/mcp-server"]': 'npx' 命令的参数，'-y' 表示自动确认安装包，'@inkdropapp/mcp-server' 是要运行的 npm 包名称，即 Inkdrop MCP Server。
    • '"env"': 环境变量配置，用于配置 Inkdrop MCP Server 访问 Inkdrop 本地 HTTP 服务器所需的连接信息。
      • '"INKDROP_LOCAL_SERVER_URL"': Inkdrop 本地 HTTP 服务器的 URL 地址。请确保与您在 Inkdrop 中配置的本地 HTTP 服务器地址一致。默认端口为 '19840'。
      • '"INKDROP_LOCAL_USERNAME"': 访问 Inkdrop 本地 HTTP 服务器的用户名。
      • '"INKDROP_LOCAL_PASSWORD"': 访问 Inkdrop 本地 HTTP 服务器的密码。

基本使用方法

配置完成后，MCP 客户端（例如 Claude Desktop）应该能够检测到并连接到 Inkdrop MCP Server。您可以通过客户端的功能调用服务器提供的工具 (Tools) 来操作 Inkdrop 笔记数据。

例如，在 Claude 中，您可以指示 Claude 使用 'read-note' 工具来读取指定 ID 的笔记，或者使用 'search-notes' 工具来搜索包含特定关键词的笔记。 具体工具的使用方法请参考工具的详细描述和输入参数要求。

调试: 如果遇到问题，可以使用 MCP Inspector 工具进行调试，或者查看 Claude 的日志文件 '~/Library/Logs/Claude/mcp-server-inkdrop.log' (macOS) 获取服务器运行日志。

信息

分类

开发者工具

访问项目