zk-mcp

zk-mcp

site icon
2025.04.17 0
Python笔记管理LLM 集成开发效率
zk-mcp 是一个 MCP 服务器,用于将 zk 管理的笔记与 LLMs(大型语言模型)集成。其目标是使 LLMs 能够高效访问由 zk 管理的知识库。
View on GitHub

Overview

基本能力

产品定位

zk-mcp 是一个用于笔记管理与 LLM 集成的工具,旨在通过 MCP 协议实现知识库的高效访问。

核心功能

  • 提供笔记获取功能(get_note
  • 提供笔记路径获取功能(get_note_paths
  • 提供关联笔记获取功能(get_linking_notes
  • 提供标签获取功能(get_tags

适用场景

  • 将 zk 管理的笔记与 LLMs 集成
  • 通过 LLMs 高效访问知识库

工具列表

  • zk:一个纯文本笔记管理助手
  • uv:用于运行 MCP 服务器的工具

常见问题解答

无明确常见问题解答部分。

使用教程

使用依赖

  • zk
  • uv
  • 任何 MCP 客户端

安装教程

  1. 克隆仓库
  2. 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/"
      }
    }
  }
}

调试方式

无明确调试步骤说明。

许可证

该项目遵循 MIT 开源许可条款,请参阅 MIT 了解完整条款。