Ntfy

ntfy-me-mcp

Um servidor Model Context Protocol (MCP) simplificado para enviar notificações via serviço ntfy (público ou auto-hospedado com suporte a token) 📲

Visão Geral

O ntfy-me-mcp fornece aos assistentes de IA a capacidade de enviar notificações em tempo real para seus dispositivos através do serviço ntfy.sh (público ou auto-hospedado com suporte a token). Seja notificado quando sua IA concluir tarefas, encontrar erros ou atingir marcos importantes - tudo sem monitoramento constante.

O servidor inclui recursos inteligentes como detecção automática de URL para criar ações de visualização e detecção inteligente de formatação markdown, facilitando para assistentes de IA criar notificações ricas e interativas sem configuração extra.

Prévia	Disponível via
	Nome Link / Selo ntfy.sh Destaque no ntfy.sh Glama.ai Smithery.ai MseeP.ai Archestra.ai

Recursos

• 🚀 Configuração Rápida: Execute com npx ou docker!
• 🔔 Notificações em Tempo Real: Receba atualizações no seu celular/desktop quando as tarefas forem concluídas
• 🎨 Notificações Ricas: Suporte para tópico, título, prioridades, tags de emoji e mensagens detalhadas
• 🔍 Busca de Notificações: Busque e filtre mensagens em cache dos seus tópicos ntfy
• 🎯 Links de Ação Inteligentes: Detecta automaticamente URLs em mensagens e cria ações de visualização
• 📄 Markdown Inteligente: Detecta e ativa automaticamente a formatação markdown quando presente
• 🔒 Seguro: Autenticação opcional com tokens de acesso
• 🔑 Mascaramento de Entrada: Armazene com segurança seu token ntfy na sua configuração vs!
• 🌐 Suporte a Auto-hospedagem: Funciona com ntfy.sh e instâncias ntfy auto-hospedadas

Em breve...

• 📨 E-mail: Envie notificações por e-mail (requer configuração do servidor de e-mail ntfy)
• 🔗 URLs de clique: Capacidade de personalizar URLs de clique
• 🖼️ URLs de imagem: Detecção inteligente de URL de imagem para incluir automaticamente URLs de imagem em mensagens e notificações
• 🏁 e mais!

Índice

Início Rápido - Configuração do Servidor MCP

Escolha a forma de configuração que corresponde ao seu cliente. Todos os exemplos abaixo usam NTFY_TOPIC como variável obrigatória e mantêm as configurações de autenticação opcionais comentadas até que você precise delas.

Exemplos de Configuração

{
  "ntfy-me-mcp": {
    "command": "npx",
    "args": ["-y", "ntfy-me-mcp"],
    "env": {
      "NTFY_TOPIC": "your-ntfy-topic",
      "NTFY_URL": "https://ntfy.sh",
      // "NTFY_TOKEN": "add-your-ntfy-token"
    }
  }
}

{
  "ntfy-me-mcp": {
    "command": "node",
    "args": ["/absolute/path/to/ntfy-me-mcp/build/index.js"],
    "env": {
      "NTFY_TOPIC": "your-ntfy-topic",
      "NTFY_URL": "https://ntfy.sh",
      // "NTFY_TOKEN": "add-your-ntfy-token"
    }
  }
}

{
  "ntfy-me-mcp": {
    "command": "docker",
    "args": [
      "run",
      "-i",
      "--rm",
      "-e",
      "NTFY_TOPIC",
      "-e",
      "NTFY_URL",
      "-e",
      "NTFY_TOKEN",
      "gitmotion/ntfy-me-mcp:latest"
    ],
    "env": {
      "NTFY_TOPIC": "your-ntfy-topic",
      "NTFY_URL": "https://ntfy.sh",
      // "NTFY_TOKEN": "add-your-ntfy-token"
    }
  }
}

{
  "$schema": "https://opencode.ai/config.json",
  "mcp": {
    "ntfy-me-mcp": {
      "type": "local",
      "command": ["npx", "-y", "ntfy-me-mcp"],
      "environment": {
        "NTFY_TOPIC": "your-ntfy-topic",
        "NTFY_URL": "https://ntfy.sh",
        // "NTFY_TOKEN": "add-your-ntfy-token"
      }
    }
  }
}

{
  "mcpServers": {
    "ntfy-me-mcp": {
      "command": "npx",
      "args": ["-y", "ntfy-me-mcp"],
      "env": {
        "NTFY_TOPIC": "your-ntfy-topic",
        "NTFY_URL": "https://ntfy.sh",
        "NTFY_TOKEN": "${NTFY_TOKEN}"
      }
    }
  }
}

{
  "mcpServers": {
    "ntfy-me-mcp": {
      "type": "local",
      "command": "npx",
      "args": ["-y", "ntfy-me-mcp"],
      "env": {
        "NTFY_TOPIC": "your-ntfy-topic",
        "NTFY_URL": "https://ntfy.sh",
        "NTFY_TOKEN": "your-access-token"
      },
      "tools": ["*"]
    }
  }
}

{
  "ntfy-me-mcp": {
    "command": "npx",
    "args": ["-y", "ntfy-me-mcp"],
    "env": {
      "NTFY_TOPIC": "your-ntfy-topic",
      "NTFY_URL": "https://your-ntfy-server.com",
      "NTFY_TOKEN": "your-access-token"
    }
  }
}

Instalação

Se você precisar instalar e executar o servidor diretamente (alternativa à configuração MCP acima):

# Clone o repositório, instale as dependências, configure o .env, compile e execute

git clone https://github.com/gitmotion/ntfy-me-mcp.git
cd ntfy-me-mcp
npm install
cp .env.example .env
npm run build
npm start

npx -y @smithery/cli install @gitmotion/ntfy-me-mcp --client claude

Configurando o Receptor de Notificações

Configuração

Variáveis de Ambiente

Crie um arquivo .env copiando o exemplo: cp .env.example .env — consulte .env.example para referência.

Autenticação

// Add this to your VS Code `mcp.json` file, either the user-level file or your workspace `.vscode/mcp.json`
// Set `NTFY_TOKEN` exactly to `"${input:ntfy_token}"` when you want VS Code to treat it as a secure prompt-backed value.

{
  "inputs": [
    {
      "type": "promptString",
      "id": "ntfy_token",
      "description": "Ntfy Token",
      "password": true
    }
  ],
  "servers": {
    "ntfy-me-mcp": {
      "command": "npx",
      "args": ["-y", "ntfy-me-mcp"],
      "env": {
        "NTFY_TOPIC": "your-ntfy-topic",
        "NTFY_URL": "https://your-ntfy-server.com",
        "NTFY_TOKEN": "${input:ntfy_token}"
      }
    }
  }
}

Ferramentas e Uso

ntfy_me: Enviando Notificações

Usando Linguagem Natural

• Ao trabalhar com seu assistente de IA, você pode usar frases naturais para solicitar notificações:

"ntfyme with a summary of the task when complete"
"Send me a notification when the build is complete"
"Notify me when the task is done"
"Alert me after generating the code"
"Message me when the process finishes"
"Send an alert with high priority"

Exemplo de Uso

{
  "title": "Code Generation Complete",
  "message": "Your React component has been
created successfully with proper
TypeScript typing.",
  "priority": "high",
  "tags": ["white_check_mark", "code", "react"]
}

{
  "success": true,
  "endpoint": "https://ntfy.sh/ntfymetest"
}

Parâmetros da Mensagem

{
  title: "Task Complete",
  message: "Regular plain text message",
  markdown: false  // Force disable
}

{
  title: "Build Complete",
  message: "View at https://github.com/org/repo/pull/123"
}

{
  title: "Pull Request Review",
  message: "Ready for final checks",
  actions: [
    {
      action: "view",
      label: "View PR",
      url: "https://github.com/org/repo/pull/123"
    },
    {
      action: "view",
      label: "View Changes",
      url: "https://github.com/org/repo/pull/123/files",
      clear: true
    }
  ]
}

ntfy_me_fetch: Consultando Notificações

Usando Linguagem Natural

Assistentes de IA entendem várias maneiras de solicitar a busca de mensagens:

"Show me my recent notifications"
"Get messages from the last hour"
"Find notifications with title 'Build Complete'"
"Search for messages with the test_tube tag"
"Show notifications from the updates topic from the last 24hr"
"Check my latest alerts"

Exemplo de Uso

{
  "since": "6h"
}

{
  "success": true,
  "messageCount": 1,
  "topics": {
    "ntfymetest": [
      {
        "id": "On4Jeo1ENDCB",
        "time": 1775859291,
        "event": "message",
        "topic": "ntfymetest",
        "message": "Test",
        "title": "Test",
        "priority": 3,
        "expires": 1775902491
      }
    ]
  }
}

Parâmetros de Busca

Desenvolvimento e Contribuições

Contribuições são bem-vindas! Consulte CONTRIBUTING.md, que inclui diretrizes gerais, etapas de configuração, etc.

Licença

Este projeto está licenciado sob a GNU General Public License v3.0 — consulte o arquivo LICENSE para detalhes.

Feito com ❤️ por gitmotion