https://github.com/rymurr/signal-mcp
https://github.com/rymurr/signal-mcp
Last synced: 5 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/rymurr/signal-mcp
- Owner: rymurr
- Created: 2025-04-02T14:06:21.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2025-04-09T11:18:43.000Z (6 months ago)
- Last Synced: 2025-04-24T01:49:17.261Z (5 months ago)
- Language: Python
- Size: 24.4 KB
- Stars: 7
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- mcp-index - Signal Integration - Send and receive messages via the Signal messaging platform, enabling AI agents to handle communication seamlessly. Supports both individual and group messaging with asynchronous operations and detailed logging for efficient message management. (Social Media)
README
# Signal MCP
An [MCP](https://github.com/mcp-signal/mcp) integration for [signal-cli](https://github.com/AsamK/signal-cli) that allows AI agents to send and receive Signal messages.
## Features
- Send messages to Signal users
- Send messages to Signal groups
- Receive and parse incoming messages
- Async support with timeout handling
- Detailed logging
## Prerequisites
This project requires [signal-cli](https://github.com/AsamK/signal-cli) to be installed and configured on your system.
### Installing signal-cli
1. **Install signal-cli**: Follow the [official installation instructions](https://github.com/AsamK/signal-cli/blob/master/README.md#installation)
2. **Register your Signal account**:
```bash
signal-cli -u YOUR_PHONE_NUMBER register
```
3. **Verify your account** with the code received via SMS:
```bash
signal-cli -u YOUR_PHONE_NUMBER verify CODE_RECEIVED
```
For more detailed setup instructions, see the [signal-cli documentation](https://github.com/AsamK/signal-cli/wiki).
## Installation
```bash
pip install -e .
# or use uv for faster installation
uv pip install -e .
```
## Usage
Run the MCP server:
```bash
./main.py --user-id YOUR_PHONE_NUMBER [--transport {sse|stdio}]
```
## API
### Tools Available
- `send_message_to_user`: Send a direct message to a Signal user
- `send_message_to_group`: Send a message to a Signal group
- `receive_message`: Wait for and receive messages with timeout support
## Development
This project uses:
- [MCP](https://github.com/mcp-signal/mcp) for agent-API integration
- Modern Python async patterns
- Type annotations throughout