esa-mcp-server

🚀 esa-mcp-server

esa-mcp-server 是一个借助 Model Context Protocol (MCP) 来连接 esa.io API 的服务器。它为用户提供了与 esa.io 进行交互的便捷途径，可实现文章的搜索、读取、创建、更新和删除等操作。

🚀 快速开始

若要使用 esa-mcp-server，你需要根据所使用的工具，准备如下配置文件：

{
  "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"
      }
    }
  }
}

✨ 主要特性

• get_search_query_document：提供在 esa.io 上搜索文章的文档说明，帮助你了解如何准确构建查询。
• search_esa_posts：可搜索 esa.io 上的文章，满足信息查找需求。
• read_esa_post、read_esa_multiple_posts：能获取单篇文章或多篇文章的详细信息。若需获取多篇文章，建议优先使用 read_esa_multiple_posts 进行批量获取。
• create_esa_post：用于创建新文章。
• update_esa_post：可更新现有文章。
• delete_esa_post：能删除指定文章。

💻 使用示例

基础用法

以下是使用 esa-mcp-server 工具的提示示例：

## 使用esa工具

为了搜索esa的信息，可以使用以下工具：

- 搜索文章时使用 `search_esa_posts` 工具。如果需要复杂查询，请先通过 `get_search_query_document` 工具了解如何准确构建查询。
- 获取文章正文分别使用 `read_esa_post` 和 `read_esa_multiple_posts` 工具。若需获取多篇文章，建议优先使用 `read_esa_multiple_posts` 进行批量获取。
- 创建、更新或删除文章时，请分别使用 `create_esa_post`、`update_esa_post` 和 `delete_esa_post` 工具。

📚 详细文档

若你想了解可用工具的详细信息，请参考 src/server.ts。

💪 贡献

欢迎大家为该项目贡献力量。