esa-mcp-server

esa-mcp-server

site icon
2025.02.17 0
TypeScript团队协作知识管理交流协作
esa-mcp-server 是一个通过 Model Context Protocol (MCP) 提供对 [esa.io](https://esa.io) API 访问的服务器。它允许用户通过 MCP 接口进行文章搜索、获取文章详情(单篇或多篇)等操作。
View on GitHub

Overview

基本能力

产品定位

esa-mcp-server 是一个中间件服务,旨在通过 MCP 协议桥接用户与 esa.io(一个团队协作和知识管理平台)的 API 交互。

核心功能

  • 文章搜索:支持根据多种条件(如排序、分页等)搜索 esa.io 上的文章。
  • 文章详情获取:支持获取单篇或多篇文章的详细信息。
  • MCP 接口:提供符合 MCP 标准的接口,便于集成到支持 MCP 的工具中。

适用场景

  • 团队知识管理:快速搜索和获取团队在 esa.io 上共享的知识文档。
  • 自动化工作流:集成到自动化工具中,自动获取或搜索相关文档。
  • 开发集成:为开发者提供便捷的 API 访问方式,支持自定义工具开发。

工具列表

  1. search_esa_posts:用于搜索 esa.io 上的文章,支持多种搜索参数。
  2. read_esa_post:获取指定文章编号的详细信息。
  3. read_esa_multiple_posts:批量获取多篇文章的详细信息。

常见问题解答

  • 为什么搜索时不返回文章正文?:为了避免在搜索时返回大量正文内容导致令牌消耗过多,设计上不包含正文。

使用教程

使用依赖

确保已安装 Node.js 和 npm。

安装教程

  1. 在配置文件中添加以下内容:
{
  "mcpServers": {
    "esa-mcp-server": {
      "command": "npx",
      "args": [
        "-y",
        "esa-mcp-server@latest"
      ]
    },
    "env": {
      "ESA_API_KEY": "your api key here",
      "DEFAULT_ESA_TEAM": "your default esa team"
    }
  }
}
  1. 运行 npx -y esa-mcp-server@latest 启动服务。

调试方式

  • 确保环境变量 ESA_API_KEYDEFAULT_ESA_TEAM 已正确设置。
  • 使用工具(如 search_esa_posts)进行测试,检查返回结果是否符合预期。

许可证

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