FastAlert MCP Server

FastAlert MCP Server

Servidor oficial do Model Context Protocol (MCP) para FastAlert. Este servidor permite que agentes de IA (como Claude, ChatGPT e Cursor) listem seus canais e enviem notificações diretamente através da API do FastAlert.

Recursos

• Descoberta de Canais: Liste todos os seus canais com filtro opcional por nome.
• Envio de Notificações: Envie mensagens ricas (título, conteúdo, ações, imagens) para um ou vários canais.

Início Rápido

{
  "mcpServers": {
    "fastalert": {
      "command": "npx",
      "args": ["-y", "fastalert-mcp-server"],
      "env": {
        "API_KEY": "your-api-key-here"
      }
    }
  }
}

Você pode encontrar sua chave de API visitando FastAlert e navegando até Configurações.

Ferramentas Disponíveis

As seguintes ferramentas estão disponíveis através deste servidor MCP. Cada ferramenta pode ser chamada por um assistente de IA para executar ações específicas.

1. list_channels

Retorna uma lista de canais FastAlert disponíveis.

Parâmetros de Entrada:

• name (string, opcional): Um termo de busca para filtrar canais por nome.

Exemplo de Chamada:

{
  "name": "Service Alerts"
}

Saída JSON Estruturada (Padrão):

{
  "status": true,
  "message": "You have fetch channels successfully",
  "data": {
    "channels": [
      {
        "uuid": "sdf12sdf-6541-5d56-s5sd-1fa513e88a81",
        "name": "Service Alerts",
        "subscriber": 1000
      }
    ]
  }
}

Saída de Texto Legível por Humanos:

Here are your FastAlert channels:

Service Alerts
UUID: sdf12sdf-6541-5d56-s5sd-1fa513e88a81
Subscribers: 1000

2. send_message

Envia uma mensagem de notificação para um ou mais canais.

Parâmetros de Entrada:

• channel-uuid (string, obrigatório): O identificador único para o canal de destino.
• title (string, obrigatório): O título da notificação de alerta.
• content (string, obrigatório): O texto principal do corpo da notificação.
• action (string, opcional): Tipo de ação ('call', 'email', 'website', 'image').
• action_value (string, opcional): O valor para a ação (ex.: uma URL ou número de telefone).
• image (string, opcional): URL ou identificador de uma imagem a ser incluída.

Exemplo de Chamada:

{
  "channel-uuid": "sdf12sdf-6541-5d56-s5sd-1fa513e88a81",
  "title": "System Update",
  "content": "A new version of the system is now live.",
  "action": "website",
  "action_value": "https://fastalert.now/updates"
}

Saída JSON Estruturada (Padrão):

{
  "status": true,
  "message": "Message has been sent successfully"
}

Saída de Texto Legível por Humanos:

Message Sent Successfully!

Your message "System Update" has been sent to Service Alerts.

Channel UUID: sdf12sdf-6541-5d56-s5sd-1fa513e88a81
Title: System Update
Content: A new version of the system is now live.

Integração com LLMs

Configuração no Cursor

1. Vá para Configurações -> MCP.
2. Clique em Adicionar Novo Servidor MCP.
3. Nome: FastAlert
4. Tipo: command
5. Comando: npx -y fastalert-mcp-server
6. Env: Adicione API_KEY.

Configuração no ChatGPT

1. Vá para Configurações -> Integrações.
2. Clique em Adicionar Servidor MCP.
3. Use a URL hospedada do seu servidor (ex.: https://mcp.fastalert.now/mcp).
4. Siga as instruções de OAuth.

Configuração no Claude

1. Abra claude_desktop_config.json.
2. Adicione a seguinte entrada:

{
  "mcpServers": {
    "fastalert": {
      "command": "npx",
      "args": ["-y", "fastalert-mcp-server"],
      "env": {
        "API_KEY": "your-api-key-here"
      }
    }
  }
}

Configuração e Desenvolvimento

Requisitos

• Node: Versão 18 ou superior é recomendada.
• API_KEY: Uma chave de API FastAlert válida é necessária para autenticação.

Instalação Local

1. Clone o repositório
2. Copie o arquivo de ambiente de exemplo:

   cp .env.example .env
   

3. Configure suas variáveis de ambiente em .env.
4. Instale as dependências:

   npm install
   

5. Compile o projeto:

   npm run build
   

6. Execute os testes de inspeção:

   npm run inspector
   

7. Execute localmente:

   npm start
   

Configuração (Variáveis de Ambiente)

As seguintes variáveis de ambiente devem ser configuradas no seu arquivo .env:

Variável	Descrição	Exemplo
API_URL	O endpoint da API do FastAlert	https://api.fastalert.now/api
FRONT_URL	A URL do seu aplicativo frontend	https://fastalert.now
BASE_URL	A URL pública onde este servidor MCP está hospedado	http://localhost:3000
API_KEY	Sua chave de API do FastAlert	your-api-key-here
PORT	(Opcional) Porta para executar o servidor	3000

Contribuindo

Contribuições são bem-vindas! Sinta-se à vontade para enviar um Pull Request.

Licença

Este projeto está licenciado sob a Licença MIT.

---