Advanced

AI Integration

AI integration is becoming increasingly important for tech note-taking workflows.
While Inkdrop doesn't include built-in AI features yet, it provides an MCP server that allows your AI model of choice to access your notes and notebooks.

MCP Server

MCP Server Demo

A Model Context Protocol server is a server that allows you to interact with AI models using a standardized protocol. Inkdrop provides an MCP server that enables AI integration with your notes.

It allows AI to search your notes, understand their context, and generate new notes based on your existing content.

Installation

  1. Set up a local HTTP server

  2. Add a server config 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"
      }
    }
  }
}

Components: Tools

  1. read-note: Retrieve the complete contents of the note by its ID from the database.
    • Required inputs:
      • noteId: The ID of the note to retrieve. It can be found as _id in the note docs. It always starts with note:.
  2. search-notes: List all notes that contain a given keyword.
    • Required inputs:
      • keyword: Keyword to search for.
    • Note: Results include truncated note bodies (200 characters). Use read-note to get full content.
    • Supports advanced search qualifiers like book:, tag:, status:, title:, etc.
  3. list-notes: List all notes with specified conditions.
    • Required inputs:
      • bookId: The notebook ID. It always starts with 'book:'.
    • Optional inputs:
      • tagIds: An array of tag IDs to filter. Each starts with 'tag:'.
      • keyword: Keyword to filter notes.
      • sort: Sort field (updatedAt, createdAt, or title). Default: updatedAt.
      • descending: Reverse the order of output. Default: true.
    • Note: Results include truncated note bodies (200 characters). Use read-note to get full content.
  4. create-note: Create a new note in the database.
    • Required inputs:
      • bookId: The notebook ID. Must start with 'book:' or be 'trash'.
      • title: The note title.
      • body: The content of the note in Markdown.
    • Optional inputs:
      • status: The note status (none, active, onHold, completed, dropped).
  5. update-note: Update an existing note in the database.
    • Required inputs:
      • _id: The note ID. Must start with 'note:'.
      • _rev: The revision ID (CouchDB MVCC-token).
      • bookId: The notebook ID. Must start with 'book:' or be 'trash'.
      • title: The note title.
      • body: The content of the note in Markdown.
    • Optional inputs:
      • status: The note status (none, active, onHold, completed, dropped).
  6. list-notebooks: Retrieve a list of all notebooks.
  7. list-tags: Retrieve a list of all tags.

For the latest information, please check out the repository.

Get help

Got any questions about this page? Feel free to ask them on the user forum here.
Previous
Restore previous revisions of note