项目简介

该项目是一个MCP服务器,旨在通过 Model Context Protocol (MCP) 协议,使得 Claude AI 能够与 esa API 进行交互。借助此服务器,Claude AI 可以执行例如搜索、创建和更新 esa 文档等操作,从而实现更智能的知识库管理和文档协作。

主要功能点

  • 文章管理: 支持 Claude AI 检索 esa 知识库中的文章列表、获取文章详情、创建新文章、更新已有文章以及删除文章。
  • 评论管理: 支持 Claude AI 获取文章评论列表、获取指定评论详情以及为文章创建新的评论。
  • 成员管理: 支持 Claude AI 获取 esa 团队成员列表以及获取指定成员的信息。

安装步骤

  1. 安装 Node.js: 确保你的环境中已安装 Node.js 18 或更高版本。

  2. 安装 esa MCP Server: 可以通过 npm 全局安装或使用 npx 直接运行。

    • 全局安装 (推荐):

      npm install -g @kajirita2002/esa-mcp-server
    • 使用 npx 直接运行:

      npx @kajirita2002/esa-mcp-server
  3. 设置环境变量: 配置访问 esa API 所需的 Access Token 和 Team Name。请在你的 shell 环境中设置以下环境变量:

    export ESA_ACCESS_TOKEN="your_esa_access_token"  # 替换为你的 esa API Access Token
    export ESA_TEAM="your_team_name"             # 替换为你的 esa 团队名称

    请务必替换 'your_esa_access_token' 和 'your_team_name' 为你实际的值。

服务器配置

对于 MCP 客户端(如 Claude AI),你需要在其配置文件(通常是 'mcp_config.json')中添加以下配置来连接到 esa MCP 服务器。

{
  "servers": {
    "esa": {
      "name": "esa",  //  服务器名称,可自定义
      "command": "npx", //  启动服务器的命令,这里使用 npx
      "args": ["-y", "@kajirita2002/esa-mcp-server"], //  启动服务器的命令参数,-y 参数用于跳过 npm 的确认提示
      "env": { // 环境变量配置
        "ESA_ACCESS_TOKEN": "your_esa_access_token", //  你的 esa API Access Token,请替换为实际值
        "ESA_TEAM": "your_team_name"    // 你的 esa 团队名称,请替换为实际值
      }
    }
  }
}

请注意,'ESA_ACCESS_TOKEN' 和 'ESA_TEAM' 应该在 MCP 客户端的配置中正确设置,或者确保运行 MCP 客户端的环境中已设置这些环境变量。

基本使用方法

  1. 启动 MCP 服务器: 如果使用全局安装,可以使用 'esa-mcp-server' 命令启动服务器。如果使用 npx,则无需单独启动,MCP 客户端会在需要时通过配置的命令启动服务器。

  2. 配置 MCP 客户端: 确保 MCP 客户端(如 Claude AI)已正确加载上述 'mcp_config.json' 配置文件。

  3. 与 Claude AI 交互: 现在你可以指示 Claude AI 使用 "esa" 服务器提供的工具来操作 esa 知识库。例如,你可以对 Claude AI 说:

    • "请在 esa 中创建一个名为 '项目X进展报告' 的新文章,内容为 '# 本周进展\n\n- 完成了功能A的实现\n- 开始了功能B的测试\n\n## 下周计划\n\n- 开始功能C的实现'"
    • "请搜索 esa 中标题包含 '会议记录' 的文章"
    • "请列出 esa 中编号为 123 的文章的所有评论"

    Claude AI 将会调用 esa MCP 服务器提供的工具来执行相应的操作,并将结果返回给你。

信息

分类

生产力应用