使用说明

项目简介

mcp-kibela 是一个 Model Context Protocol (MCP) 服务器的实现,它允许 AI 助手(如 Claude、Cursor 等 MCP 客户端)安全地访问和利用 Kibela 知识库中的信息。通过此服务器,AI 助手可以搜索 Kibela 笔记、获取个人笔记以及按 ID 或路径检索笔记内容,从而增强 AI 在知识管理和信息检索方面的能力。

主要功能点

  • 笔记搜索 (Note Search): 允许 AI 助手通过关键词在 Kibela 中搜索相关的笔记。
  • 我的笔记 (My Notes): 提供获取用户最近在 Kibela 中编辑或查看的笔记列表的功能。
  • 笔记内容 (Note Content): 允许 AI 助手根据笔记 ID 获取指定笔记的完整内容,包括文本和评论。
  • 路径查找笔记 (Note by Path): 支持通过 Kibela 笔记的路径(例如 '/notes/123')来获取笔记内容。

安装步骤

你可以选择以下任一方式安装 mcp-kibela 服务器:

方法一:使用 Smithery (推荐 Claude Desktop 用户)

Smithery 是一个用于安装和管理 MCP 服务器的工具。如果你使用 Claude Desktop,这是最简便的安装方式。

  1. 打开终端,运行以下命令:
    npx -y @smithery/cli install @kj455/mcp-kibela --client claude

方法二:使用 npm 包管理器

如果你的环境配置了 Node.js 和 npm,可以使用 npm 全局安装 mcp-kibela。

  1. 打开终端,运行以下命令:
    npm install -g @kj455/mcp-kibela

方法三:从源代码构建 (推荐 Cursor 用户或需要自定义配置的用户)

如果你希望从源代码构建或需要为 Cursor 等客户端配置,请按照以下步骤操作:

  1. 克隆仓库到本地:
    git clone https://github.com/kj455/mcp-kibela.git
  2. 进入项目目录:
    cd mcp-kibela
  3. 安装项目依赖:
    npm install
  4. 构建项目:
    npm run build

服务器配置

配置前准备

无论使用哪种安装方式,都需要先获取以下信息:

  • Kibela 团队名称 (KIBELA_TEAM): 你的 Kibela 团队域名,例如 'your-team-name.kibe.la',你只需要 'your-team-name' 部分。
  • Kibela API Token (KIBELA_TOKEN): 用于 API 访问的 Token。请参考 Kibela 官方文档 获取 Token。

MCP 客户端配置示例

以下是针对不同 MCP 客户端的配置示例。你需要将配置信息添加到你的 MCP 客户端设置中。

Claude Desktop 配置 (claude_desktop_config.json)

{
  "mcpServers": {
    "kibela": {
      "command": "mcp-kibela",
      "env": {
        "KIBELA_TEAM": "your-team-name",  // 替换为你的 Kibela 团队名称
        "KIBELA_TOKEN": "your-token"      // 替换为你的 Kibela API Token
      }
    }
  }
}

Cursor 配置 (Cursor Settings -> Features -> MCP Servers -> Add new MCP server)

  • Name: 'kibela' (或其他你自定义的名称)
  • Type: 'command'
  • Command: 'env KIBELA_TEAM=your_team_name KIBELA_TOKEN=your_token node /path/to/mcp-kibela/dist/index.js'
    • 'your_team_name': 替换为你的 Kibela 团队名称
    • 'your_token': 替换为你的 Kibela API Token
    • '/path/to/mcp-kibela/dist/index.js': 替换为 'mcp-kibela' 项目 'dist/index.js' 文件的绝对路径 (如果你是使用 npm 或 Smithery 安装,则不需要修改路径,仅当从源代码构建时需要指定)

注意: 确保 'KIBELA_TEAM' 和 'KIBELA_TOKEN' 环境变量已正确配置,MCP 服务器才能正常连接到 Kibela API。

基本使用方法

  1. 启动 MCP 服务器: 如果你使用 Smithery 或 npm 安装,MCP 服务器会在 MCP 客户端连接时自动启动。如果从源代码构建,你可能需要手动运行 'node dist/index.js' 启动服务器。
  2. 在 MCP 客户端中使用: 在支持 MCP 协议的 AI 客户端中(如 Claude, Cursor),启用并连接到配置好的 'kibela' MCP 服务器。
  3. 调用工具: 在 AI 客户端中,你可以指示 AI 助手使用 Kibela 相关的工具,例如:
    • “搜索 Kibela 中关于 [关键词] 的笔记” (对应 'kibela_search_notes' 工具)
    • “获取我的最新 Kibela 笔记” (对应 'kibela_get_my_notes' 工具)
    • “获取 ID 为 [笔记ID] 的 Kibela 笔记内容” (对应 'kibela_get_note_content' 工具)
    • “打开 Kibela 路径为 [笔记路径] 的笔记” (对应 'kibela_get_note_from_path' 工具)

AI 助手将通过 MCP 服务器调用相应的 Kibela 工具,并返回检索到的信息。

信息

分类

生产力应用