MCP server for AI agents
Optional Model Context Protocol layer that exposes EventOre control and data plane APIs to Cursor, Claude, and other MCP clients.
Role in the architecture
EventOre separates control plane (provider registration, UI cascade, no broker TCP) from data plane (connections, publish, subscribe, inspect). The MCP server is a thin agent adapter — it never embeds Kafka or MQTT clients. All broker I/O goes through the same backend delegates as the React UI.
AI client ── MCP (stdio or HTTP) ──► eventore-mcp ── REST/SSE ──► EventOre backend
│
control plane ◄───────────┼───────────► data plane
/api/v1/control │ /api/v1/connections
▼
Brokers / cloud streams
See also Control & data plane and Architecture.
Package and transports
Source: mcp/eventore-mcp (Node 20+, TypeScript). Published image: ghcr.io/vijayptiwari/eventore-mcp.
| Variable | Default | Description |
|---|---|---|
EVENTORE_API_URL | http://localhost:8080/api/v1 | Backend API base (must include /api/v1) |
MCP_TRANSPORT | stdio | stdio for Cursor/desktop; http for Kubernetes |
MCP_PORT | 3100 | HTTP listen port when MCP_TRANSPORT=http |
MCP_AUTH_TOKEN | (unset) | Optional Bearer token on /mcp (HTTP only; does not authenticate to backend) |
Recommended agent workflow
- Read
eventore://configor calleventore_get_config— deployment mode andcontrolPlane.uiCascade. - Read
eventore://control-planeoreventore_get_control_plane— confirm the target protocol is inactiveProtocols. - Use prompt
eventore_discoverfor a full onboarding brief, oreventore_protocol_guidefor broker URL hints. - Data plane:
eventore_create_connection→ validate → list destinations → publish/consume/inspect. - Admins only: control-plane
eventore_register_provider/eventore_deregister_provider(requires ADMIN mode andADMIN_BROKER_OPS).
MCP tools
Control plane
| Tool | API | Purpose |
|---|---|---|
eventore_get_control_plane | GET /control/plane | Revision, providers, UI cascade |
eventore_list_providers | GET /control/providers | All provider descriptors |
eventore_get_provider | GET /control/providers/{protocol} | One provider metadata |
eventore_get_provider_status | GET /control/providers/{protocol}/status | Registration and routability |
eventore_register_provider | POST .../register | Runtime register (ADMIN) |
eventore_deregister_provider | DELETE .../register | Runtime deregister (ADMIN) |
Data plane — connections & messaging
| Tool | Purpose |
|---|---|
eventore_get_config | Mode, allowed actions, modules, embedded control plane summary |
eventore_list_connections | List connection profiles |
eventore_create_connection | Create profile (protocol must be registered) |
eventore_update_connection | Update profile fields |
eventore_delete_connection | Remove profile and subscriptions |
eventore_validate_connection | Connectivity test |
eventore_list_destinations | Topics / queues / streams |
eventore_publish_message | Unified publish |
eventore_consume_messages | Short SSE sample (not WebSocket) |
eventore_protocol_guide | Per-protocol hints or NL protocol suggestion |
eventore_quick_probe | Ephemeral create → validate → list → optional samples → delete |
Data plane — inspect & Kafka admin
| Tool | Purpose |
|---|---|
eventore_inspect_cluster | Cluster / broker metadata |
eventore_inspect_consumer_groups | Consumer groups or Pulsar subscriptions |
eventore_inspect_lag | Consumer lag (Kafka) |
eventore_inspect_search | Topic message search / sample |
eventore_triage_incident | 0.3.0 development preview: heuristic broker, lag and DLQ diagnostics; failed or unsupported checks may be omitted |
eventore_kafka_publish | Kafka produce with key/partition headers |
eventore_kafka_create_topic | Create topic (ADMIN) |
eventore_kafka_delete_topic | Delete topic (ADMIN) |
eventore_kafka_list_acls | List ACLs (ADMIN) |
MCP resources
| URI | Content |
|---|---|
eventore://architecture | Static map of planes, APIs, and tool groupings |
eventore://config | Live GET /config |
eventore://control-plane | Live GET /control/plane |
eventore://providers | Live provider list |
eventore://connections | Live connection profiles |
eventore://protocol-guides | Static connection/publish hints (all eight protocol types) |
MCP prompts
Prompts return ready-to-run playbooks for agents:
eventore_discover— loads config + control plane + architecture mapeventore_probe_broker— ephemeral probe viaeventore_quick_probeeventore_kafka_inspection— cluster → groups → lag → search sequenceeventore_incident_triage— 0.3.0 development preview: diagnostic investigation playbook; does not establish root cause or perform remediationeventore_control_plane_ops— register / deregister / status checklist
Cursor configuration (stdio)
cd mcp/eventore-mcp && npm install && npm run build
Add to Cursor MCP settings (see mcp/eventore-mcp/cursor-mcp.json.example):
{
"mcpServers": {
"eventore": {
"command": "node",
"args": ["C:/path/to/eventore/mcp/eventore-mcp/dist/index.js"],
"env": {
"EVENTORE_API_URL": "http://localhost:8080/api/v1",
"MCP_TRANSPORT": "stdio"
}
}
}
}
Docker & Helm (published artifacts)
CI publishes ghcr.io/vijayptiwari/eventore-mcp and chart oci://ghcr.io/vijayptiwari/charts/eventore-mcp. Full image/chart list: Published Docker images & Helm charts.
# Stack: backend + frontend + MCP
docker compose -f docker/docker-compose.stack.yml up -d
# Published MCP image only (backend elsewhere)
docker pull ghcr.io/vijayptiwari/eventore-mcp:0.2.1
docker run -p 3100:3100 -e MCP_TRANSPORT=http \
-e EVENTORE_API_URL=http://host.docker.internal:8080/api/v1 \
ghcr.io/vijayptiwari/eventore-mcp:0.2.1
helm install eventore oci://ghcr.io/vijayptiwari/charts/eventore --version 0.2.1 \
-f deploy/helm/eventore/values-published.yaml
helm install eventore-mcp oci://ghcr.io/vijayptiwari/charts/eventore-mcp --version 0.2.1 \
--set eventore.apiUrl=http://eventore-backend:8080/api/v1
HTTP health: GET :3100/health. MCP endpoint: POST/GET :3100/mcp (streamable HTTP).
Policy and security
- Deployment mode on the backend applies to MCP the same as the UI — READONLY blocks publish and connection CRUD.
- MCP_AUTH_TOKEN protects the MCP HTTP endpoint only; configure Spring Security separately if the backend API must be authenticated.
- MCP pods do not need broker network access if the backend already reaches brokers.
Limitations
- Live streaming in the UI uses WebSocket
/ws/stream; MCP consume tools use SSE for bounded samples. - Cloud protocols (Kinesis, GCP Pub/Sub, Azure Service Bus) are supported when the provider JAR is deployed and registered; inspect/admin tools vary by provider.
- MCP does not replace the web console for multi-topic live view or export.
Related: Deployment · Control & data plane · mcp/eventore-mcp/README.md in the repository.