使用说明

项目简介

本仓库提供了一个多功能的MCP服务器实现,旨在增强 Claude Desktop 的能力。通过集成多种外部服务,如本地 Obsidian 知识库、Kibela 知识库、Brave 搜索引擎和 Slack 协作平台,本服务器使 Claude 能够访问更广泛的信息和执行多样化的操作。

主要功能点

  • Obsidian 知识库集成:
    • 列出 Obsidian Vault 中的文件和文件夹。
    • 搜索 Obsidian Vault 中的文件和文件夹。
    • 读取 Obsidian Vault 中 Markdown 和文本文件的内容。
    • 在 Obsidian Vault 文件内容中进行搜索。
  • Kibela 知识库集成:
    • 在 Kibela 知识库中搜索笔记。
    • 搜索 Kibela 笔记内容。
    • 查看 Kibela 笔记的详细内容。
    • 获取最近更新的 Kibela 笔记列表。
    • 列出 Kibela 知识库中的所有群组。
  • Brave 搜索引擎集成:
    • 执行 Brave Web Search 进行网页搜索,适用于一般查询和信息收集。
    • 执行 Brave Local Search 进行本地搜索,查找本地商家和地点。
  • Slack 协作平台集成:
    • 列出 Slack 工作区中的公开频道。
    • 向 Slack 频道发送新消息。
    • 回复 Slack 消息线程。
    • 给 Slack 消息添加 Emoji 表情。
    • 获取 Slack 频道的消息历史记录。
    • 获取 Slack 消息线程的回复。
    • 获取 Slack 工作区中的用户列表。
    • 获取 Slack 用户的详细个人资料。
    • 获取 Slack 频道中未回复的提及消息。
    • 获取 Slack 频道最近的活动摘要。

安装步骤

  1. 安装 Node.js: 确保你的系统已安装 Node.js (版本 16 或更高)。你可以从 Node.js 官网 下载并安装。
  2. 克隆仓库: 使用 Git 克隆本仓库到本地:
    git clone https://github.com/Akito-n/use-mcp-on-claude.git
  3. 进入仓库目录: 导航到克隆下来的仓库目录:
    cd use-mcp-on-claude
  4. 安装依赖: 使用 npm 安装项目依赖:
    npm install
  5. 构建项目: 构建 TypeScript 代码到 JavaScript:
    npm run build

服务器配置

要将此 MCP 服务器配置到 Claude Desktop 中,你需要编辑 'claude_desctop_config.json' 文件。以下是配置示例,你可以根据需要选择启用部分或全部工具。

{
  "mcpServers": {
    "obsidian-vault": {  // Obsidian 工具,在 Claude 中以 @obsidian-vault 调用
      "command": "/path/to/your/node",  // 替换为你的 Node.js 可执行文件路径,例如 /usr/local/bin/node
      "args": [
        "/path/to/use-mcp-on-claude/build/index.js" // 替换为项目 build 目录下的 index.js 路径,例如 /Users/yourname/use-mcp-on-claude/build/index.js
      ],
      "env": {
        "OBSIDIAN_VAULT_PATH": "/path/to/your/Obsidian/vault" // 替换为你的 Obsidian Vault 文件夹的绝对路径,例如 /Users/yourname/Obsidian/MyVault
      }
    },
    "kibela-knowledge-base": { // Kibela 工具,在 Claude 中以 @kibela-knowledge-base 调用
      "command": "/path/to/your/node",
      "args": [
        "/path/to/use-mcp-on-claude/build/index.js"
      ],
      "env": {
        "KIBELA_TEAM_NAME": "your-kibela-team-name", // 替换为你的 Kibela 团队名称
        "KIBELA_ACCESS_TOKEN": "your-kibela-access-token"  // 替换为你的 Kibela 访问令牌
      }
    },
    "brave-search-engine": { // Brave 搜索工具,在 Claude 中以 @brave-search-engine 调用
      "command": "/path/to/your/node",
      "args": [
        "/path/to/use-mcp-on-claude/build/index.js"
      ],
      "env": {
        "BRAVE_API_KEY": "your-brave-search-api-key" // 替换为你的 Brave Search API 密钥
      }
    },
    "slack-workspace": { // Slack 工具,在 Claude 中以 @slack-workspace 调用
      "command": "/path/to/your/node",
      "args": [
        "/path/to/use-mcp-on-claude/build/index.js"
      ],
      "env": {
        "SLACK_BOT_TOKEN": "your-slack-bot-token", // 替换为你的 Slack Bot Token
        "SLACK_TEAM_ID": "your-slack-team-id"    // 替换为你的 Slack Team ID
      }
    }
  },
  "globalShortcut": ""
}

请务必替换以下占位符:

  • '/path/to/your/node': 你的 Node.js 可执行文件的实际路径。可以使用 'which node' 或 'where node' 命令查找。
  • '/path/to/use-mcp-on-claude': 你克隆的 'use-mcp-on-claude' 仓库在本地的路径。
  • '/path/to/your/Obsidian/vault': 你的 Obsidian Vault 文件夹的绝对路径。
  • 'your-kibela-team-name', 'your-kibela-access-token', 'your-brave-search-api-key', 'your-slack-bot-token', 'your-slack-team-id': 替换为你自己的 API 密钥、令牌和团队信息。这些信息通常需要在相应服务的开发者平台或管理后台获取。

基本使用方法

  1. 启动服务器: 在 Claude Desktop 中配置 'claude_desctop_config.json' 后,重启 Claude Desktop 以加载配置。

  2. 调用工具: 在 Claude 的对话框中,你可以使用 '@工具名称' 来调用配置的工具,例如:

    • '@obsidian-vault obsidian-search path:/ query:你的关键词' (在 Obsidian Vault 根目录搜索包含关键词的文件)
    • '@kibela-knowledge-base kibela-search query:你的搜索词' (在 Kibela 知识库中搜索笔记)
    • '@brave-search-engine brave_web_search query:今天的新闻' (使用 Brave Web Search 搜索今天的新闻)
    • '@slack-workspace slack_list_channels' (列出 Slack 工作区中的公开频道)

    具体的工具名称和参数,请参考代码中 'server.tool()' 定义的工具名和参数描述。你可以在每个工具的 'configureServer' 函数中找到详细的工具定义和参数说明。

注意: 首次配置或修改 'claude_desctop_config.json' 后,需要重启 Claude Desktop 才能使配置生效。

信息

分类

生产力应用