Initial asterisk-mcp: MCP server for vessel troubleshoot stack.
Part of GeneseasX golden-vessel tooling (see homelab-vault Projects/vessel-troubleshoot-stack).
This commit is contained in:
39
README.md
Normal file
39
README.md
Normal file
@@ -0,0 +1,39 @@
|
||||
# asterisk-mcp
|
||||
|
||||
MCP server for **Asterisk in Docker** on the ship VM (`shipPortal`). SSH + `docker exec` + `asterisk -rx`.
|
||||
|
||||
## Quick start
|
||||
|
||||
```bash
|
||||
cd ~/Projects/asterisk-mcp
|
||||
python3 -m venv .venv && .venv/bin/pip install -e .
|
||||
```
|
||||
|
||||
### Connect
|
||||
|
||||
```text
|
||||
asterisk_connect(
|
||||
ssh_host="10.20.30.222",
|
||||
ssh_key_path="/Users/nearxos/.ssh/id_ed25519",
|
||||
container="asterisk",
|
||||
name="golden-asterisk"
|
||||
)
|
||||
asterisk_test_connection()
|
||||
asterisk_pjsip_show_endpoints()
|
||||
```
|
||||
|
||||
## Tools
|
||||
|
||||
| Tool | Description |
|
||||
|------|-------------|
|
||||
| `asterisk_connect` / `asterisk_use_target` | Persisted targets |
|
||||
| `asterisk_cli` | Arbitrary `asterisk -rx` |
|
||||
| `asterisk_pjsip_show_endpoints` | Registration state |
|
||||
| `asterisk_core_show_channels` | Active calls |
|
||||
| `asterisk_get_logs` | Tail `/var/log/asterisk/full` |
|
||||
| `asterisk_read_config` | Read file in container |
|
||||
| `asterisk_module_reload` | Reload module (writes) |
|
||||
|
||||
## License
|
||||
|
||||
MIT
|
||||
Reference in New Issue
Block a user