esa.io

esa-mcp-server

esa-mcp-server é um servidor que permite utilizar a API do esa.io por meio do Model Context Protocol (MCP).

📢 Aviso importante

O servidor MCP local oficial da esa foi lançado! 🎉

O MCP Server oficial é multifuncional e oferece uma ampla gama de recursos, como gerenciamento de equipes, gerenciamento de artigos, gerenciamento de comentários, gerenciamento de categorias, ajuda e documentação, Resource, Prompt e muito mais. Recomendamos que você também o verifique.

Diferenças entre o oficial e este repositório

O MCP Server oficial e a implementação deste repositório apresentam trade-offs:

• Oficial: multifuncional, com muitas possibilidades (prompt do sistema: aproximadamente 11,3k tokens)
• Este repositório: funcionalidade limitada a ferramentas de busca, adição e atualização de artigos, mas com design compacto (prompt do sistema: aproximadamente 3,4k tokens, menos de 1/3 em comparação ao oficial)

Recomendação

Recomendamos o uso do MCP Server oficial, mas, como ele pressiona bastante a janela de contexto, é recomendável utilizá-lo em conjunto com abordagens de carregamento tardio, como d-kimuson/modular-mcp, ou com operações como adicioná-lo apenas a projetos específicos ou apenas quando necessário.

Se você não quiser se preocupar com esses inconvenientes, o esa-mcp-server deste repositório pressiona relativamente menos o contexto, sendo mais fácil de adicionar mesmo isoladamente.

Funcionalidades

• get_search_query_document: fornecimento de documentação para pesquisar artigos no esa.io
• search_esa_posts: pesquisa de artigos no esa.io
• read_esa_post, read_esa_multiple_posts: obtenção de detalhes de artigos (único ou múltiplos)
• create_esa_post: criação de artigos
• update_esa_post: atualização de artigos
• delete_esa_post: exclusão de artigos

Usage

Prepare o arquivo de configuração conforme as ferramentas que você utilizará, como mostrado abaixo.

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

Exemplo de prompt

## Using esa tools

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 ツールを利用します。

Ferramentas disponíveis

Consulte src/server.ts.

Contribution

Contribuições são bem-vindas!