Inkdropapp MCP Server

🚀 Inkdrop MCP Server

An Model Context Protocol server designed for the Inkdrop Local HTTP Server API.

📦 Installation

1. Set up the local HTTP server.

2. Add the server configuration to Claude Desktop:

   • 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"
      }
    }
  }
}

✨ Features

Tools

1. read-note: Retrieve the full content of a note from the database by its ID.
   • Required input:
     • noteId: The ID of the note. It can be found in the note document and always starts with note:.
2. search-notes: List all notes containing the given keyword.
   • Required input:
     • keyword: The keyword to search for.
   • Note: The results include truncated note bodies (up to 200 characters). Use read-note to get the full content.
   • Supports advanced search qualifiers such as book:, tag:, status:, title:, etc.
3. list-notes: List all notes in the specified notebook.
   • Required input:
     • bookId: The notebook ID. It must start with book: or be trash.
   • Optional input:
     • tagIds: An array of tag IDs for filtering, each starting with tag:.
     • keyword: A keyword for filtering notes.
   • Note: The results include truncated note bodies (up to 200 characters). Use read-note to get the full content.
4. create-note: Create a new note in the database.
   • Required input:
     • bookId: The notebook ID. It must start with book: or be trash.
     • title: The title of the note.
     • body: The content of the note in Markdown format.
   • Optional input:
     • status: The status of the note (none, active, onHold, completed, dropped).
5. update-note: Update an existing note in the database.
   • Required input:
     • _id: The note ID. It must start with note:.
     • _rev: The version control token (CouchDB MVCC identifier).
     • bookId: The notebook ID. It must start with book: or be trash.
     • title: The title of the note.
     • body: The content of the note in Markdown format.
   • Optional input:
     • status: The status of the note (none, active, onHold, completed, dropped).
6. list-notebooks: Retrieve a list of all notebooks.
7. list-tags: Retrieve a list of all tags.

🛠️ Debugging

Since the MCP server runs via standard input/output, debugging can be challenging. For the best debugging experience, we highly recommend using the MCP Inspector.

You can start the inspector using npm with the following command:

npx @modelcontextprotocol/inspector

Copy and paste http://localhost:19840 into the URL field of the inspector and click Connect.

The inspector will display detailed information about the running MCP server and provide an interactive interface to test and debug the tools.

📚 Documentation

The full API documentation can be found on GitHub.

👥 Contributors

• [your GitHub username]

Thank you for using Inkdrop's MCP Server!