📤 ntfy-me-mcp

ntfy 서비스(공개 또는 토큰 지원이 있는 자체 호스팅)를 통해 알림을 보내기 위한 간소화된 MCP(Model Context Protocol) 서버 📲

개요

ntfy-me-mcp는 AI 비서가 ntfy 서비스(공개 또는 토큰 지원이 포함된 자체 호스팅)를 통해 기기에 실시간 알림을 보낼 수 있도록 지원합니다. AI가 작업을 완료하거나, 오류가 발생하거나, 중요한 이정표에 도달하면 알림을 받을 수 있으며, 이 모든 것이 지속적인 모니터링 없이 가능합니다.

서버에는 뷰 작업을 생성하기 위한 자동 URL 감지, 스마트 마크다운 서식 감지와 같은 지능형 기능이 포함되어 있어 AI 도우미가 추가 구성 없이 풍부하고 대화형 알림을 쉽게 만들 수 있습니다.

다음을 통해 이용 가능:

이름	링크/배지
글라마.에이아이
스미서리.ai

특징

🚀 빠른 설정 : npx 또는 docker로 실행하세요!
🔔 실시간 알림 : 작업이 완료되면 휴대폰/데스크톱에서 업데이트를 받으세요.
🎨 풍부한 알림 : 주제, 제목, 우선순위, 이모티콘 태그 및 상세 메시지 지원
🔍 알림 가져오기 : ntfy 주제에서 캐시된 메시지를 가져오고 필터링합니다.
🎯 스마트 액션 링크 : 메시지의 URL을 자동으로 감지하고 보기 액션을 생성합니다.
📄 지능형 마크다운 : 마크다운 서식이 있는 경우 자동으로 감지하고 활성화합니다.
🔒 보안 : 액세스 토큰을 통한 선택적 인증
🔑 입력 마스킹 : vs 설정에 ntfy 토큰을 안전하게 저장하세요!
🌐 자체 호스팅 지원 : ntfy.sh 및 자체 호스팅 ntfy 인스턴스 모두에서 작동합니다.

(곧 출시됩니다...)

📨 이메일 : 이메일로 알림을 보냅니다(ntfy 이메일 서버 구성 필요)
🔗 클릭 URL : 클릭 URL을 사용자 정의하는 기능
🖼️ 이미지 URL : 메시지 및 알림에 이미지 URL을 자동으로 포함하는 지능형 이미지 URL 감지
🏁 및 기타!

빠른 시작 - MCP 서버 구성

NPM / NPX (권장 방법)

시스템에 npm/npx가 설치되어 있어야 합니다.
이 방법은 서버를 설정하는 간단하고 가벼운 방법을 제공하므로 대부분의 사용자에게 권장됩니다.

MCP 호환 어시스턴트를 가장 쉽게 설정하려면 MCP 구성에 다음을 추가하세요.

최소 구성(ntfy.sh의 공개 주제에 대한)

지엑스피1

전체 구성(개인 서버 또는 보호된 주제용)

옵션 1: 구성에서 직접 토큰 사용

{
  "ntfy-me-mcp": {
    "command": "npx",
    "args": ["ntfy-me-mcp"],
    "env": {
      "NTFY_TOPIC": "your-topic-name",
      "NTFY_URL": "https://your-ntfy-server.com",
      "NTFY_TOKEN": "your-auth-token" // Use if using a protected topic/server
    }
  }
}

옵션 2: 보안 토큰 처리를 위한 VS Code 입력 사용(권장)

VS Code settings.json 파일에 다음을 추가하세요.

"mcp": {
  "inputs": [
    { // Add this to your inputs array
      "type": "promptString",
      "id": "ntfy_token",
      "description": "Ntfy Token",
      "password": true
    }
  ],
  "servers": {
    // Other servers...
    "ntfy-me-mcp": {
      "command": "npx",
      "args": ["ntfy-me-mcp"],
      "env": {
        "NTFY_TOPIC": "your-topic-name",
        "NTFY_URL": "https://your-ntfy-server.com",
        "NTFY_TOKEN": "${input:ntfy_token}", // Use the input id variable for the token
        "PROTECTED_TOPIC": "true" // Prompts for token and masks it in your config
      }
    }
  }
}

이 설정을 사용하면 VS Code는 서버를 시작할 때 토큰을 입력하라는 메시지를 표시하고, 입력 시 토큰은 마스크됩니다.

도커

Docker에서 MCP와 함께 사용

시스템에 Docker가 설치되어 있어야 합니다.
이 방법은 컨테이너화된 환경에서 서버를 실행하는 데 유용합니다.
Docker Hub 또는 GitHub Container Registry에서 제공되는 공식 Docker 이미지를 사용할 수 있습니다.

Docker 이미지:

gitmotion/ntfy-me-mcp:latest (Docker 허브)
ghcr.io/gitmotion/ntfy-me-mcp:latest 컨테이너 레지스트리)

MCP 구성(예: VS Code settings.json)에서:

"mcp": {
  "servers": {
    "ntfy-mcp": {
      "command": "docker",
      "args": [
        "run",
        "-i",
        "--rm",
        "-e",
        "NTFY_TOPIC",
        "-e",
        "NTFY_URL",
        "-e",
        "NTFY_TOKEN",
        "-e",
        "PROTECTED_TOPIC",         
        "gitmotion/ntfy-me-mcp", // OR use ghcr.io/gitmotion/ntfy-me-mcp:latest
      ],
      "env": {
        "NTFY_TOPIC": "your-topic-name",
        "NTFY_URL": "https://your-ntfy-server.com",
        "NTFY_TOKEN": "${input:ntfy_token}",
        "PROTECTED_TOPIC": "true"
      }
    }
  }
}

설치

서버를 직접 설치하고 실행해야 하는 경우(위의 MCP 구성에 대한 대안):

옵션 1: 글로벌 설치

npm install -g ntfy-me-mcp

옵션 2: npx로 실행

npx ntfy-me-mcp

옵션 3: 로컬 설치

# Clone the repository
git clone https://github.com/gitmotion/ntfy-me-mcp.git
cd ntfy-me-mcp

# Install dependencies
npm install

# Copy the example environment file and configure it
cp .env.example .env
# Edit .env with your preferred editor and update the variables
# nano .env  # or use your preferred editor

# Build the project
npm run build

# Start the server
npm start

옵션 4: node 명령을 사용하여 로컬로 빌드하고 사용

서버를 개발하거나 사용자 정의하는 경우 노드를 사용하여 직접 실행하는 것이 좋습니다.

# Clone the repository
git clone https://github.com/gitmotion/ntfy-me-mcp.git
cd ntfy-me-mcp

# Install dependencies
npm install

# Copy the example environment file and configure it
cp .env.example .env
# Edit the .env file to set your NTFY_TOPIC and other optional settings
# nano .env  # or use your preferred editor

# Build the project
npm run build

# Run using node directly
npm start

MCP를 사용하여 로컬로 구축된 서버 사용

로컬로 빌드된 버전을 사용하도록 MCP를 구성할 때 node 명령과 빌드된 index.js 파일의 경로를 지정하세요.

{
  "ntfy-me": {
    "command": "node",
    "args": ["/path/to/ntfy-mcp/build/index.js"],
    "env": {
      "NTFY_TOPIC": "your-topic-name",
      //"NTFY_URL": "https://your-ntfy-server.com", // Use if using a self-hosted server
      //"NTFY_TOKEN": "your-auth-token" // Use if using a protected topic/server
    }
  }
}

args 배열에 build/index.js 파일의 절대 경로를 사용하는 것을 잊지 마세요.

옵션 5: MCP Marketplace 설치

Smithery를 통해 설치

Smithery를 통해 Claude Desktop에 ntfy-me-mcp를 자동으로 설치하려면:

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

구성

환경 변수

제공된 예제를 복사하여 프로젝트 디렉토리에 .env 파일을 만듭니다.

# Copy the example file
cp .env.example .env

# Edit the file with your preferred editor
nano .env  # or vim, code, etc.

.env 파일에는 다음 변수가 포함되어야 합니다.

# Required
NTFY_TOPIC=your-topic-name

# Optional - Configure these if using a private/protected ntfy server
# NTFY_URL=https://ntfy.sh  # Default is ntfy.sh, change to your self-hosted ntfy server URL if needed
                            # Include port if needed, e.g., https://your-ntfy-server.com:8443
# NTFY_TOKEN=your-access-token  # Required for authentication with protected topics/servers
# PROTECTED_TOPIC=false  # Set to "true" if your topic requires authentication (helps prevent auth errors)

참고 : PROTECTED_TOPIC 플래그는 애플리케이션이 주제에 대한 인증 필요 여부를 판단하는 데 도움이 됩니다. "true"로 설정되고 토큰이 제공되지 않으면 토큰을 입력하라는 메시지가 표시됩니다. 이를 통해 보호된 주제에서 인증 실패를 방지할 수 있습니다.

용법

입증

이 서버는 인증된 ntfy 엔드포인트와 인증되지 않은 ntfy 엔드포인트를 모두 지원합니다.

공개 주제 : ntfy.sh 또는 다른 공개 서버에서 공개 주제를 사용하는 경우 인증이 필요하지 않습니다.
보호된 주제 : 보호된 주제나 개인 서버의 경우 액세스 토큰을 제공해야 합니다.

인증이 필요하지만 제공되지 않으면 토큰을 추가하는 방법을 설명하는 명확한 오류 메시지가 표시됩니다.

알림 수신자 설정

기기에 ntfy 앱을 설치하세요
선택한 주제를 구독하세요( NTFY_TOPIC 설정과 동일)

알림 보내기(ntfy_me 도구)

이 섹션에서는 ntfy_me 도구를 사용하여 알림을 보내는 데 관련된 모든 기능을 다룹니다.

자연어 사용

AI 비서를 사용할 때 다음과 같은 자연스러운 문구를 사용할 수 있습니다.

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

메시지 매개변수

이 도구는 다음 매개변수를 허용합니다.

매개변수	설명	필수의
작업 제목	알림 제목	예
작업 요약	알림 본문	예
우선 사항	메시지 우선순위: 최소, 낮음, 기본값, 높음, 최대	아니요
태그	알림 태그 배열(이모티콘 단축 코드 지원)	아니요
가격 인하	마크다운 서식을 활성화하기 위한 부울(true/false)	아니요
행위	클릭 가능한 링크에 대한 뷰 작업 객체 배열	아니요

예:

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

이렇게 하면 체크 표시 이모티콘이 포함된 높은 우선순위 알림이 전송됩니다.

액션 링크

actions 매개변수를 사용하여 알림에 클릭 가능한 작업 버튼을 추가하거나, 서버가 메시지에서 URL을 자동으로 감지하도록 할 수 있습니다.

자동 URL 감지

메시지 본문에 URL이 있는 경우, 서버는 처음 감지된 URL을 기준으로 최대 3개의 뷰 액션(ntfy의 최대 제한)을 자동으로 생성합니다. 이를 통해 액션 배열을 직접 지정하지 않고도 클릭 가능한 링크를 쉽게 포함할 수 있습니다.

예를 들어, 이 메시지는 다음과 같습니다.

{
  taskTitle: "Build Complete",
  taskSummary: "Your PR has been merged! View the changes at https://github.com/org/repo/pull/123 or check the deployment at https://staging.app.com"
}

두 URL에 대한 뷰 작업을 자동으로 생성하여 알림에서 쉽게 클릭할 수 있도록 합니다.

수동 작업 구성

더욱 세밀하게 제어하려면 다음과 같이 수동으로 작업을 지정할 수 있습니다.

재산	설명	필수의
행동	"view"여야 합니다	예
상표	표시할 버튼 텍스트	예
URL	클릭하면 열리는 URL	예
분명한	클릭 시 알림을 지울지 여부(선택 사항)	아니요

동작 링크의 예:

{
  taskTitle: "Pull Request Review",
  taskSummary: "Your code has been reviewed and is ready for final checks",
  priority: "high",
  tags: ["check", "code"],
  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
    }
  ]
}

이모지 단축 코드

태그에 이모티콘 단축 코드를 사용하여 시각적 표시를 할 수 있습니다.

warning → ⚠️
check → ✅
rocket → 🚀
tada → 🎉

지원되는 이모티콘 단축코드의 전체 목록을 확인하세요.

마크다운 서식

알림은 지능적인 감지 기능을 통해 풍부한 마크다운 서식을 지원합니다! taskSummary 에 마크다운 구문을 포함하면 서버가 자동으로 감지하여 마크다운 구문 분석을 활성화합니다. 명시적으로 markdown: true 설정할 필요가 없습니다.

자동 감지

서버는 다음과 같은 일반적인 마크다운 패턴을 확인합니다.

헤더(#, ## 등)
목록(-, *, 숫자)
코드 블록(```)
링크( 텍스트 )
굵게/기울임꼴 ( 텍스트 , 텍스트 )

이러한 패턴이 감지되면 해당 메시지에 대한 마크다운 구문 분석이 자동으로 활성화됩니다.

수동 오버라이드

대부분의 경우 자동 감지가 작동하지만 마크다운 구문 분석을 명시적으로 제어할 수도 있습니다.

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

메시지 검색(ntfy_me_fetch 도구)

이 섹션에서는 ntfy_me_fetch 도구를 사용하여 메시지를 가져오고 필터링하는 데 관련된 모든 기능을 다룹니다.

자연어 사용

AI 도우미는 메시지 가져오기를 요청하는 다양한 방법을 이해합니다.

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

메시지 매개변수

이 도구는 다음 매개변수를 허용합니다.

매개변수	설명	필수의
ntfy토픽	메시지를 가져올 주제(기본값은 NTFY_TOPIC 환경 변수)	아니요
~부터	메시지를 검색할 최대 기간('10m', '1h', '1d', 타임스탬프, 메시지 ID 또는 '모두')	아니요
메시지 ID	ID로 특정 메시지 찾기	아니요
메시지 텍스트	정확한 텍스트 내용이 포함된 메시지 찾기	아니요
메시지 제목	정확한 제목/주제가 있는 메시지 찾기	아니요
우선순위	특정 우선 순위 수준을 가진 메시지 찾기	아니요
태그	특정 태그가 있는 메시지 찾기	아니요

예시

최근 메시지 가져오기

{
  since: "30m"  // Get messages from last 30 minutes
}

제목 및 우선 순위로 필터링

{
  messageTitle: "Build Complete",
  priorities: "high",
  since: "1d"
}

태그를 사용하여 다른 주제 검색

{
  ntfyTopic: "updates",
  tags: ["error", "warning"],
  since: "all"
}

특정 메시지 찾기

{
  messageId: "xxxxXXXXxxxx"
}

다음을 포함한 전체 세부 정보가 포함된 메시지가 반환됩니다.

메시지 ID 및 타임스탬프
주제와 제목
콘텐츠 및 우선순위
태그 및 첨부 파일
액션 링크 및 만료

참고 : 메시지 기록 사용 가능 여부는 ntfy 서버의 캐시 설정에 따라 달라집니다. 공개 ntfy.sh 서버는 일반적으로 메시지를 12시간 동안 캐시합니다.

개발

소스에서 빌드

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

특허

이 프로젝트는 GNU General Public License v3.0에 따라 라이선스가 부여되었습니다. 자세한 내용은 LICENSE 파일을 참조하세요.

기여하다

기여를 환영합니다! 풀 리퀘스트를 제출해 주세요.

gitmotion 이 ❤️로 만들었습니다

Integrations

📤 ntfy-me-mcp

개요

다음을 통해 이용 가능:

목차

특징

(곧 출시됩니다...)

빠른 시작 - MCP 서버 구성

NPM / NPX (권장 방법)

최소 구성(ntfy.sh의 공개 주제에 대한)

전체 구성(개인 서버 또는 보호된 주제용)

옵션 1: 구성에서 직접 토큰 사용

옵션 2: 보안 토큰 처리를 위한 VS Code 입력 사용(권장)

도커

Docker에서 MCP와 함께 사용

설치

옵션 1: 글로벌 설치

옵션 2: npx로 실행

옵션 3: 로컬 설치

옵션 4: node 명령을 사용하여 로컬로 빌드하고 사용

MCP를 사용하여 로컬로 구축된 서버 사용

옵션 5: MCP Marketplace 설치

Smithery를 통해 설치

구성

환경 변수

용법

입증

알림 수신자 설정

알림 보내기(ntfy_me 도구)

자연어 사용

메시지 매개변수

액션 링크

자동 URL 감지

수동 작업 구성

이모지 단축 코드

마크다운 서식

자동 감지

수동 오버라이드

메시지 검색(ntfy_me_fetch 도구)

자연어 사용

메시지 매개변수

예시

개발

소스에서 빌드

특허

기여하다