esa-mcp-server

重要

官方 MCP 服务已发布。今后请使用官方服务。

• 发布 esa 官方本地 MCP 服务 - ReleaseNotes/2025/09/17 - docs.esa.io

esa MCP 服务

适用于 esa.io 的模型上下文协议（MCP）服务。

目录

• 使用方法
  • 先决条件
  • 配置
    • 使用 npx
    • 使用 Docker
  • 只读模式
• MCP 工具
  • 文章
  • 标签
  • 评论
• 许可证

使用方法

先决条件

使用此 MCP 服务前，你需要从自己的 esa.io 团队生成个人访问令牌：

1. 前往 https://<TEAM_NAME>.esa.io/user/applications
2. 创建新的个人访问令牌
3. 复制令牌以供配置使用

配置

你可以通过 npx 或 Docker 运行此服务。

使用 npx

将以下配置添加到你的 MCP 客户端：

{
  "mcpServers": {
    "esa": {
      "command": "npx",
      "args": [
        "-y",
        "@koki-develop/esa-mcp-server@latest"
      ],
      "env": {
        "ESA_TEAM": "<your-team-name>",
        "ESA_ACCESS_TOKEN": "<your-personal-access-token>"
      }
    }
  }
}

将 <your-team-name> 和 <your-personal-access-token> 替换为你的团队名称和个人访问令牌。

使用 Docker

如果你更喜欢使用 Docker，请使用以下配置：

{
  "mcpServers": {
    "esa": {
      "command": "docker",
      "args": [
        "run",
        "-i",
        "--rm",
        "-e",
        "ESA_TEAM",
        "-e",
        "ESA_ACCESS_TOKEN",
        "ghcr.io/koki-develop/esa-mcp-server:latest"
      ],
      "env": {
        "ESA_TEAM": "<your-team-name>",
        "ESA_ACCESS_TOKEN": "<your-personal-access-token>"
      }
    }
  }
}

只读模式

若要启用只允许读取操作的只读模式，请添加 --readonly 标志。

使用 npx：

{
  "mcpServers": {
    "esa": {
      "command": "npx",
      "args": [
        "-y",
        "@koki-develop/esa-mcp-server@latest",
        "--readonly"
      ],
      "env": {
        "ESA_TEAM": "<your-team-name>",
        "ESA_ACCESS_TOKEN": "<your-personal-access-token>"
      }
    }
  }
}

使用 Docker：

{
  "mcpServers": {
    "esa": {
      "command": "docker",
      "args": [
        "run",
        "-i",
        "--rm",
        "-e",
        "ESA_TEAM",
        "-e",
        "ESA_ACCESS_TOKEN",
        "ghcr.io/koki-develop/esa-mcp-server:latest",
        "--readonly"
      ],
      "env": {
        "ESA_TEAM": "<your-team-name>",
        "ESA_ACCESS_TOKEN": "<your-personal-access-token>"
      }
    }
  }
}

在只读模式下，仅可执行以下操作：

• get_posts - 获取文章
• get_post - 获取指定文章
• get_tags - 获取标签
• get_post_comments - 获取文章评论

写入操作（create_post、update_post、delete_post、create_post_comment、update_comment、delete_comment）已禁用。

MCP 工具

• 文章
• 标签
• 评论

文章

工具	描述
get_posts	获取 esa 团队的文章列表。支持搜索查询、筛选、排序和分页。返回文章元数据，包括标题、内容、标签、分类、作者信息和互动指标（评论、星标、关注）。可通过 include 参数选择是否包含评论和星标用户。支持嵌套包含，例如 'comments,comments.stargazers'。注意：为减少上下文大小，文章内容（body_md）会截断至 300 个字符，并通过 body_truncated 字段指示是否发生截断。
get_post	根据文章编号获取 esa 团队中的指定文章。返回完整的文章详情，包括标题、内容（Markdown）、标签、分类、作者信息、修订历史和互动指标。可选择包含评论和星标用户。支持嵌套包含，例如 'comments,comments.stargazers'。
create_post	在 esa 团队中创建新文章。必须提供标题，也可选择提供内容、标签、分类、WIP 状态和其他元数据。返回已创建的文章信息，包括分配的文章编号和 URL。
update_post	更新 esa 团队中已有的文章。必须提供文章编号，也可选择提供更新后的内容、标签、分类、WIP 状态和其他元数据。返回已更新的文章信息，包括修订详情。
delete_post	从 esa 团队中删除已有文章。必须提供文章编号。文章将被永久删除，且无法恢复。删除成功后会返回确认消息。

标签

工具	描述
get_tags	获取 esa 团队使用的所有标签列表。返回标签名称及其关联的文章数量，并按文章数量降序排序。支持分页。

评论

工具	描述
get_post_comments	获取 esa 团队中特定文章的评论列表。需要提供文章编号，并支持分页。返回评论元数据，包括内容、作者信息、时间戳和互动指标（星标数）。
create_post_comment	在 esa 团队的现有文章下创建新评论。需要提供文章编号和 Markdown 格式的评论内容。返回已创建评论的信息，包括 ID、内容、时间戳和作者详情。
update_comment	更新 esa 团队文章中的现有评论。需要提供评论 ID 和 Markdown 格式的新内容。返回更新后的评论信息，包括内容、时间戳和作者详情。
delete_comment	删除 esa 团队中的现有评论。需要提供评论 ID。评论将被永久删除且无法恢复。成功删除后会返回确认消息。

许可证

本项目采用 MIT 许可证授权，详情请参阅 LICENSE 文件。

版权所有 (c) 2025 Koki Sato