Skip to content

uehaj/mcp-notifier

Repository files navigation

MCP Notifier

npm downloads smithery badge

A Model Context Protocol (MCP) server that provides desktop notification capabilities using node-notifier.

Features

  • Simple notification tool
  • Advanced notification tool with additional options
  • Support for different notification types (info, success, warning, error)
  • Customizable notification settings

Platform Support

This MCP server uses node-notifier and works across multiple platforms:

  • macOS: Uses macOS Notification Center
  • Windows: Uses Windows Toast Notifications (Windows 8+) or taskbar balloons (< Windows 8)
  • Linux: Uses notify-send command for Gnome/Ubuntu notifications

For more details on platform-specific behavior, visit the node-notifier documentation.

Usage Options

You can use MCP Notifier in two ways:

Option 1: Run Directly with npx

The simplest way to use MCP Notifier is with npx:

# Run directly with npx
npx @uehaj/mcp-notifier

This will download and execute the package with a single command.

Option 2: Clone and Build from Source

# Clone repository
git clone https://github.com/uehaj/mcp-notifier.git
cd mcp-notifier

# Install dependencies
npm install

# Build the project
npm run build

# Run the server
node build/index.js

Integration with Claude Desktop

  1. Edit your Claude Desktop configuration file:

    • macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
    • Windows: %APPDATA%\Claude\claude_desktop_config.json
  2. Choose one of the following configuration methods:

For npx method (recommended):

{
  "mcpServers": {
    "mcp-notifier": {
      "command": "npx",
      "args": [
        "@uehaj/mcp-notifier"
      ]
    }
  }
}

For local git clone method:

{
  "mcpServers": {
    "mcp-notifier": {
      "command": "node",
      "args": [
        "/absolute/path/to/cloned/mcp-notifier/build/index.js"
      ]
    }
  }
}
  1. Restart Claude Desktop

Smithery Integration

This MCP server is available on Smithery. Since it requires desktop access to function properly, it must be installed locally rather than used as a hosted service.

Run via Smithery CLI:

# Run using Smithery CLI
npx @smithery/cli run @uehaj/mcp-notifier

Manual setup from repository:

Follow the "Clone and Build from Source" instructions above.

Available Tools

notify

Basic notification tool with the following parameters:

  • title: The notification title (required)
  • message: The notification message (required)
  • icon: Optional path to an icon file
  • sound: Whether to play a sound (optional boolean)
  • wait: Whether to wait for the notification to close (optional boolean)

notify-advanced

Advanced notification tool with more options:

  • title: The notification title (required)
  • message: The notification message (required)
  • type: Notification type - "info", "success", "warning", or "error" (optional)
  • timeout: Auto-close timeout in milliseconds (optional)
  • closeLabel: Text for close button (macOS only, optional)
  • actions: Array of action button labels (macOS only, optional)

Testing

Run tests:

# For npx method
npx @modelcontextprotocol/inspector npx @uehaj/mcp-notifier

# For git clone method
cd mcp-notifier
npx @modelcontextprotocol/inspector node build/index.js

Development

Publishing to npm

The package includes several npm scripts to help with publishing:

# Publish the current version
npm run release

# Increment patch version (1.0.0 -> 1.0.1) and publish
npm run release:patch

# Increment minor version (1.0.0 -> 1.1.0) and publish
npm run release:minor

# Increment major version (1.0.0 -> 2.0.0) and publish
npm run release:major

These commands will:

  1. Automatically run the build process
  2. Update the version number as needed
  3. Publish the package to npm with public access

You need to be logged in to npm (npm login) before running these commands.

Requirements

  • Node.js 18 or higher
  • npm 6 or higher
  • Desktop environment (Windows, macOS, or Linux)
  • Access permissions to notification system

License

MIT

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Packages

No packages published