@payghaam/mcp-server
OfficialIt helps coding agents find and add missing Payghaam analytics events that journeys wait on, plus draft journeys.
Identify which project a key belongs to and whether instrumentation is needed (
get_project_context)List expected events that haven't arrived and are blocking journeys (
list_expected_events)List active journeys and their event dependencies (
list_journeys)Describe a journey in plain English with the state of every event it needs (
describe_journey)Generate typed event constants for Flutter, Android, iOS, React Native, or Web (
generate_event_constants)Report events as added to code so the dashboard distinguishes "done" from "waiting on release" (
mark_events_declared)Create a draft journey from a plan for human review, requiring an author key (
create_journey_draft)
Generates typed event constant files for Dart, enabling type-safe Payghaam analytics event tracking in Dart applications.
Generates typed event constant files for Kotlin, enabling type-safe Payghaam analytics event tracking in Kotlin applications.
Generates typed event constant files for Swift, enabling type-safe Payghaam analytics event tracking in Swift applications.
Generates typed event constant files for TypeScript, enabling type-safe Payghaam analytics event tracking in TypeScript applications.
Click on "Deploy Server".
Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state.
In the chat, type
@followed by the MCP server name and your instructions, e.g., "@@payghaam/mcp-server Add the Payghaam events my onboarding journey needs."
That's it! The server will respond to your query, and you can continue using it as needed.
Here is a step-by-step guide with screenshots.
@payghaam/mcp-server
An MCP server that tells your coding agent which analytics events your Payghaam journeys are waiting for, so it can add them to your app.
Why this exists
A journey step that waits for kyc_completed does nothing at all if your app never sends kyc_completed. It doesn't error — users simply arrive at that step and stay there. This server exposes which events are missing, what they block, and generated constants to call, and then lets your own agent decide where in the code they belong.
Your code never leaves your machine. This server only reads journey and event metadata from Payghaam.
Related MCP server: model-context-stream
Setup
You can authenticate either via Browser OAuth (Recommended - zero keys in config files) or with a static API key.
Option 1: Browser OAuth (Recommended)
Run the login command in your terminal:
npx -y @payghaam/mcp-server loginThis opens your browser to authorize your MCP client and select which Payghaam project to connect. Your credentials are securely cached in ~/.payghaam/credentials.json with automatic token refresh.
Cursor
In .cursor/mcp.json:
{
"mcpServers": {
"payghaam": {
"command": "npx",
"args": ["-y", "@payghaam/mcp-server"]
}
}
}Claude Desktop
In claude_desktop_config.json:
{
"mcpServers": {
"payghaam": {
"command": "npx",
"args": ["-y", "@payghaam/mcp-server"]
}
}
}Claude Code
claude mcp add payghaam -- npx -y @payghaam/mcp-serverOption 2: Static API Key
Create an MCP key in the Payghaam dashboard under Project settings → Code. It starts with ek_mcp_.
Cursor
In .cursor/mcp.json:
{
"mcpServers": {
"payghaam": {
"command": "npx",
"args": ["-y", "@payghaam/mcp-server"],
"env": { "PAYGHAAM_API_KEY": "ek_mcp_..." }
}
}
}Claude Code
claude mcp add payghaam --env PAYGHAAM_API_KEY=ek_mcp_... -- npx -y @payghaam/mcp-serverEnvironment
Variable | Required | Default |
| yes | — |
| no |
|
Tools
get_project_context— which project this key belongs to and whether anything needs instrumentinglist_expected_events— events your journeys wait on that your app has never sentlist_journeys— active journeys and the events each depends ondescribe_journey— one journey in plain English, with the state of every event it needsgenerate_event_constants— the typed constants file for Dart, Kotlin, Swift or TypeScriptmark_events_declared— report back that you've added the tracking calls
A typical session
"Add the Payghaam events my onboarding journey needs."
The agent calls list_expected_events, sees kyc_completed and card_issued are missing and that onboarding depends on both, calls describe_journey to understand what stalls, writes the generated constants file, adds the tracking calls on the success paths it finds in your code, and calls mark_events_declared.
Your dashboard then shows those events as present in the code but not yet arriving. Once a build ships and real users hit those paths, they flip to arriving on their own and the journey's readiness climbs without anyone touching it.
License
MIT
Available Tools
7 toolscreate_journey_draftDraft a journeyA
Create a DRAFT journey from a plan. Read the payghaam://journey-plan-schema resource first — it has the format and a worked example. The draft sends nothing; a person reviews and activates it in the dashboard, and it is labelled there as machine-written. Requires an author key (ek_mcpa_). If the plan is invalid you get the specific problems back and can fix and retry.
Inputs: plan (required).
describe_journeyDescribe a journeyARead-only
What one journey does, step by step in plain English, plus the state of every event it needs. Use this to understand what a missing event actually blocks before deciding where to track it.
Inputs: journeyId (required).
generate_event_constantsGenerate typed event constantsARead-only
The generated constants file for this project's events, in the language you ask for. Write it into the repo and call the constants instead of string literals — event matching is exact, so a typo is a journey that silently never advances. Regenerating produces an identical file.
Inputs: platform (required), events, packageName.
get_project_contextProject overviewBRead-only
Which Payghaam project this key belongs to and whether anything needs instrumenting.
Inputs: no named parameters.
list_expected_eventsList events the app doesn't send yetARead-only
Events that this project's journeys wait on but which have never arrived from the app. Each one is a step where users currently get stuck forever. Start here.
Inputs: no named parameters.
list_journeysList journeysARead-only
Every active journey in this project and the events each one depends on.
Inputs: no named parameters.
mark_events_declaredReport events as added to the codeAIdempotent
Call this once you have actually written the tracking calls. It tells the dashboard the events exist in the app but haven't arrived yet, which distinguishes 'nobody has done this' from 'done, waiting on a release'. Do not call it for events you only planned to add.
Inputs: events (required).
Tool Schema Changelog
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
Loading tool schema changelog…
TDQS
Scored across 7 tools
Each tool targets a distinct resource and action: listing missing events, listing journeys, describing a single journey, generating constants, marking events as declared, creating a draft, and getting project context. No two tools perform overlapping functions.
All tool names follow a verb_noun pattern using snake_case (list_, describe_, generate_, mark_, create_, get_). The verb clearly indicates the action and the noun the resource, making the naming predictable and consistent.
With 7 tools, the server is well-scoped. Every tool serves a distinct step in the workflow of instrumenting event tracking, and there are no redundant or missing tools that would bloat or thin the set.
The tool set covers the full lifecycle for the server's purpose: understanding project context, identifying missing events, exploring journeys, generating constants, marking events as declared, and creating journey drafts. There are no dead ends or obvious gaps for the intended workflow.
Maintenance
Related MCP Connectors
MCP server for Appcircle mobile CI/CD platform.
Analytics your AI agent can actually use. Track, experiment, and optimize via MCP.
MCP server for your apps' tools and custom tools, plus hosted AI agents and approval-gated workflows
MCP server for building and testing AI agents with multi-model experimentation and insights.
Related MCP Servers
- AlicenseAqualityDmaintenanceAn MCP server that allows coding agents to look up contextual rules and patterns on demand, providing just-in-time guidance for specific tasks like writing tests or authoring UI.28MIT
- AlicenseNot gradedqualityCmaintenanceAn event-driven MCP server that enables agents to share context streams, publish and subscribe to events, manage tasks, and follow protocols, keeping a fleet of agents mutually context-aware in real time.1MIT
- AlicenseAqualityBmaintenanceAn MCP server that enables coding agents to set up and manage webhook infrastructure, including provisioning endpoints, event logs, replay, and testing.13Apache 2.0
- FlicenseNot gradedqualityDmaintenanceA comprehensive MCP server that provides AI assistants with powerful access to Pendo analytics through 15 specialized tools, transforming natural language questions into deep product insights.-