Notifly MCP Server

Servidor MCP Notifly - permitindo que agentes de IA forneçam documentação confiável e em tempo real do Notifly, além de exemplos de código SDK para integrações perfeitas.

Documentação

Notifly MCP Server

npm version npm downloads License

O Notifly MCP Server permite que agentes de IA entreguem documentação do Notifly em tempo real e confiável, além de exemplos de código dos SDKs para integrações perfeitas diretamente em qualquer cliente compatível com MCP.

Implementa o Model Context Protocol (MCP), um padrão aberto que permite que LLMs interajam com ferramentas e dados externos.

Principais recursos:

  • Busca na Documentação — Pesquise na documentação do Notifly (guias do usuário, referência da API, solução de problemas, melhores práticas) com classificação semântica.
  • Busca de SDKs — Explore os SDKs do Notifly (iOS, Android, Flutter, React Native, JavaScript), modelos do Google Tag Manager e exemplos de implementação. Encontre símbolos e obtenha trechos prontos para produção.

Instalação

Pré-requisitos

  • Node.js >= 18

Início Rápido

Instale o Notifly MCP Server:

npm i -g notifly-mcp-server@latest

Crie ou atualize o .mcp.json na raiz do seu projeto (ou no local de configuração que seu cliente MCP utiliza). Usar npx garante que você sempre execute a versão publicada mais recente:

Configuração MCP compartilhada

Adicione o Notifly com:

{
  "mcpServers": {
    "notifly-mcp-server": {
      "command": "npx",
      "args": ["-y", "notifly-mcp-server@latest"]
    }
  }
}

Coloque isso na configuração MCP do seu cliente (por exemplo, nas configurações da extensão do VS Code, ~/.cursor/mcp.json, ou nas configurações MCP do seu cliente Copilot).

Configuração do Claude Code

Abra seu terminal para acessar a CLI do Claude Code. Execute o seguinte comando para registrar o Notifly MCP Server.

claude mcp add --transport stdio notifly-mcp-server -- npx -y notifly-mcp-server@latest

Configuração do Codex

Abra o ~/.codex/config.toml. Adicione a seguinte configuração e reinicie a CLI do Codex:

[mcp_servers]
  [mcp_servers.notifly]
  command = "npx"
  args = ["-y", "notifly-mcp-server@latest"]

Reinicie seu cliente MCP para carregar a configuração.

Opções de Linha de Comando

notifly-mcp-server [options]

--version, -v  Show version
--help, -h     Show help

Uso

Este pacote executa como um servidor MCP. Uma vez configurado no seu cliente MCP, você pode invocar search_docs e search_sdk diretamente da paleta de ferramentas do cliente ou da interface do assistente.

Observações:

  • É necessário acesso à rede para buscar páginas de documentação e arquivos-fonte dos SDKs.
  • Os timeouts padrão e as contagens de resultados podem ser ajustados por meio de variáveis de ambiente:
    • DOCS_SEARCH_MAX_RESULTS (padrão: 3)
    • SDK_SEARCH_MAX_RESULTS (padrão: 3)

Desenvolvimento Local

Configuração Local

# Clone and install
git clone https://github.com/notifly-tech/notifly-mcp-server.git
cd notifly-mcp-server
npm install

# Build
npm run build

# Run tests
npm test

# Development mode (watch for changes)
npm run dev

Configuração do Cliente MCP para Desenvolvimento Local

Antes da publicação do pacote, configure seu cliente MCP para usar o build local:

{
  "mcpServers": {
    "notifly": {
      "command": "node",
      "args": ["/absolute/path/to/notifly-mcp-server/dist/index.js"]
    }
  }
}

Substitua /absolute/path/to/notifly-mcp-server pelo caminho real do seu projeto.

Contribuindo

Contribuições são bem-vindas! Leia nossas diretrizes em CONTRIBUTING.md e abra uma issue para discutir mudanças significativas antes de enviar um PR.

Suporte

Se você encontrar problemas ou tiver solicitações de recursos, abra uma issue no GitHub. Para dúvidas de uso, consulte a documentação e os exemplos retornados pelas ferramentas.

Licença

Licença MIT com Restrições Personalizadas — consulte LICENSE para detalhes.

Recursos