mirror of
https://github.com/Luchexx/wacrm.git
synced 2026-11-02 17:29:45 +00:00
78f2f79d3b
Introduce mcp-server/ — a stdio Model Context Protocol server that wraps the /api/v1 public API so MCP clients (Claude, Cursor, etc.) can drive a self-hosted wacrm instance in natural language. - Thin wrapper over the existing REST API; all auth, scoping, and rate limiting stay server-side. No new backend surface. - Read-only by default: write and broadcast tools are only registered when WACRM_ENABLE_WRITES / WACRM_ENABLE_BROADCASTS are set, layered on top of the API key's own scopes. send_broadcast also requires an explicit confirm and is marked destructive. - Registry-ready: server.json manifest, package.json mcpName linked to it (io.github.arnasdon/wacrm-mcp), and glama.json for discovery. - Docs: docs/mcp.md + README bullet + mcp-server/README.md. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
20 lines
785 B
Plaintext
20 lines
785 B
Plaintext
# The base URL of your wacrm instance (no trailing slash).
|
|
WACRM_BASE_URL=https://your-crm.example.com
|
|
|
|
# A wacrm API key. Create one in the dashboard:
|
|
# Settings → API keys → New API key.
|
|
# The key's scopes decide what the server can do — grant the minimum.
|
|
WACRM_API_KEY=wacrm_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
|
|
|
|
# --- Write guards (opt-in) ------------------------------------------
|
|
# By default the server is READ-ONLY: it never exposes tools that
|
|
# change data or send messages, no matter what the API key allows.
|
|
# Turn these on deliberately.
|
|
|
|
# Expose contact create/update and single-message sending.
|
|
# WACRM_ENABLE_WRITES=true
|
|
|
|
# Expose the broadcast tool (mass sends — highest risk). Requires
|
|
# WACRM_ENABLE_WRITES as well.
|
|
# WACRM_ENABLE_BROADCASTS=true
|