Payram Helper

You run the Payram Helper MCP Server to teach MCP-aware clients how to integrate with your self-hosted Payram stack. It provides one-click tools for assessing codebases, scaffolding starter apps, generating cross-language snippets, reading inline docs, and validating connectivity to your Payram deployment. This server is designed to streamline onboarding, integration workflows, and in-editor guidance for Copilot and other MCP-enabled clients.

How to use

You interact with the MCP server through an MCP-enabled client. Start by ensuring your server is running, then use the provided tools to assess projects, scaffold starter templates, generate code snippets for Payments, Payouts, Webhooks, and more, and run connectivity checks against your Payram deployment. Use the readiness flow to verify that environment variables are present and that the Payram backend is reachable before attempting real transactions.

How to install

Prerequisites: you need Node.js (version 18 or later) and a JavaScript package manager. This setup uses Yarn in the examples.

# Install dependencies
yarn install

# Prepare environment (copy example and fill keys)
cp .env.example .env
# Fill PAYRAM_BASE_URL and PAYRAM_API_KEY in .env (or generate via the MCP tool if available)

# Run the MCP server in development mode
yarn dev

# The server exposes HTTP + SSE transports at:
# http://localhost:3333/mcp and http://localhost:3333/mcp/sse
```} ]},{

Health check and client setup are straightforward. You can verify the server is healthy with a simple health endpoint and point your MCP client to the provided URL.

Notes and configuration

Environment variables shown for running the server include PAYRAM_BASE_URL and PAYRAM_API_KEY. These are used by the server when validating connectivity to your Payram deployment. Ensure .env is present and populated before performing connectivity tests.

The server supports a ready-made readiness flow. When you trigger the test workflow, it ensures the environment file exists, creates it if missing, and then attempts a real connection using your credentials. This helps you confirm that the Payram backend is reachable before you rely on it for production usage.

Available tools

test_payram_connection

POSTs to the Payram API endpoint using the API key to validate connectivity and returns status, headers, and actionable errors if the environment is incomplete.

generate_env_template

Produce an environment template to initialize .env with required keys for Payram integration.

generate_setup_checklist

Create a checklist detailing prerequisites and steps to prepare a Payram-enabled project for MCP integration.

scaffold_payram_app

Generate full starter apps for multiple frameworks (Express, Next.js, FastAPI, Laravel, Gin, Spring Boot) with payments, payouts, webhooks, and a browser console.

assess_payram_project

Scan project manifests like package.json, requirements.txt, go.mod, pom.xml, and .env to detect frameworks and Payram dependencies, then propose next steps.

generate_payment_sdk_snippet

Emit JavaScript SDK code for creating payments and querying status.

generate_payment_http_snippet

Emit raw HTTP snippets for create + status workflows in Python/Go/PHP/Java.

generate_payout_sdk_snippet

Provide JS SDK code for creating payouts and tracking status.

generate_referral_sdk_snippet

Offer SDK code for referrals including linking and status checks.

generate_webhook_handler

Produce webhook handlers for common frameworks to receive and process events.

get_payram_doc_by_id

Fetch in-editor documentation by ID for inline knowledge.

list_payram_docs

List available inline docs to Copilot for quick reference.

prepare_payram_test

Share a readiness checklist, ensure environment files exist, and prepare for the test flow.