Zk MCP

🚀 zk-mcp Introduction

zk-mcp is an MCP server designed to integrate the knowledge base managed by zk with large language models (LLMs). Its goal is to enable LLMs to efficiently access the knowledge base managed by zk.

🚀 Quick Start

Prerequisites

• zk: A plain-text based note-taking assistant
• uv
• Any MCP client

Usage

1. Clone this repository.
2. Add the following settings to servers.json:

{
  "mcpServers": {
    "zk": {
      "alwaysAllow": [
        "get_note",
        "get_note_paths",
        "get_linking_notes",
        "get_tags"
      ],
      "args": [
        "--directory",
        "/path/to/github.com/koei-kaji/zk-mcp/",
        "run",
        "server.py"
      ],
      "command": "uv",
      "env": {
        "ZK_DIR": "/path/to/zk-note-directory/"
      }
    }
  }
}