Getting Started with Notify-MCP¶
Welcome to Notify-MCP! This guide will help you get up and running with cross-platform AI collaboration in minutes.
What is Notify-MCP?¶
Notify-MCP is a pub-sub MCP server that enables teams to share notifications, decisions, and status updates across different AI assistants (Claude, ChatGPT, Gemini). It breaks down the information silos that form when team members use different AI platforms.
Key Benefits¶
- ๐ Cross-Platform: Works with Claude, ChatGPT, Gemini, and any MCP-compatible AI assistant
- ๐พ Persistent: SQLite-based storage enables team collaboration through shared databases
- ๐ Smart Filtering: Subscribe to channels with filters for priority, tags, themes, and sender roles
- ๐ Zero Setup: In-memory mode for testing, SQLite for team sharingโno server required
Quick Start Path¶
Follow this 3-step path to get started:
1. Install Notify-MCP (5 minutes)¶
Install Python, uv package manager, and Notify-MCP:
# Install uv
curl -LsSf https://astral.sh/uv/install.sh | sh
# Clone and install
git clone <repository-url>
cd notify-mcp
uv sync
2. Configure Your AI Assistant (5 minutes)¶
Add Notify-MCP to your Claude Desktop, ChatGPT, or Gemini configuration:
{
"mcpServers": {
"notify-mcp": {
"command": "uv",
"args": ["run", "python", "-m", "notify_mcp"],
"cwd": "/path/to/notify-mcp"
}
}
}
3. Start Collaborating (10 minutes)¶
Create your first channel, publish a notification, and retrieve it:
# Create a channel
"Create a channel called 'engineering' for technical updates"
# Publish a notification
"Publish to engineering: API v2.0 has been released to production"
# Retrieve notifications
"Show me recent notifications from the engineering channel"
What You'll Learn¶
Installation Guide¶
- Installing Python 3.11+ and uv
- Cloning and setting up Notify-MCP
- Verifying the installation
- Platform-specific instructions (macOS, Linux, Windows)
Configuration Guide¶
- Configuring Claude Desktop / Claude Code
- Setting up storage (in-memory vs. SQLite)
- Configuring for team collaboration
- Environment variables reference
Quick Start Tutorial¶
- Creating your first channel
- Publishing notifications
- Subscribing with filters
- Retrieving notification history
- Common usage patterns
Next Steps¶
After completing the Getting Started guides:
- Explore Use Cases - See real-world scenarios demonstrating Notify-MCP's value
- Review API Reference - Learn about all available tools and resources
- Follow Best Practices - Optimize your team's notification workflow
- Browse Examples - Study code examples and integration patterns
Need Help?¶
- Installation Issues? Check the Installation Guide
- Configuration Problems? See Configuration Guide
- General Questions? Visit the Troubleshooting Guide
- Bug Reports? Create an issue on GitHub
Ready to get started? Begin with Installation โ