Paystack Model Context Protocol Bridge

This implementation of the Paystack Model Context Protocol (MCP) server enables autonomous agents to interface with Paystack's comprehensive suite of financial services using standardized MCP communication patterns via tool invocation.

Core Capabilities

• Orchestrate the creation and lifecycle management of your service catalog within Paystack.
• Comprehensive administration of customer entities (initiation, listing, modification, verification).
• Management of payment initiation, verification, and delegated charging capabilities.
• Control over payment mandates and transactional approvals.
• Access to institutional banking identifiers and geographical operational parameters.
• Retrieval and mass extraction of recorded transactional history.

Deployment Instructions

Ensure that the placeholder your_paystack_secret_key_here is substituted with your valid Paystack confidential access token.

Installation via Smithery Utility

To automate the deployment of the Paystack MCP server for environments like Claude Desktop using [Smithery](https://smithery.ai/server/@kohasummons/paystack-mcp): bash npx -y @smithery/cli install @kohasummons/paystack-mcp --client claude #### Conventional Installation bash npm install -g @kohasummons/paystack-mcp ### Execution Initiate the operational server by executing: bash paystack-mcp Alternatively, invoke via NPX within your MCP configuration schema: { "mcpServers": { "paystack-mcp": { "command": "npx", "args": [ "-y", "@kohasummons/paystack-mcp" ], "env": { "PAYSTACK_SECRET_KEY": "your_paystack_secret_key_here" } } } }

Configuration for Claude Desktop

Incorporate the subsequent object into your `claude_desktop_config.json` file. Refer to [this external resource](https://modelcontextprotocol.io/quickstart/user) for supplementary guidance. { "mcpServers": { "paystack-mcp": { "command": "npx", "args": ["-y", "@kohasummons/paystack-mcp"], "env": { "PAYSTACK_SECRET_KEY": "your_paystack_secret_key_here" } } } }

Integration with Goose Desktop Client

To onboard this extension into Goose Desktop, copy and paste the ensuing URI into the browser's address bar: goose://extension?cmd=npx&arg=-y&arg=@kohasummons/paystack-mcp&id=paystack-mcp&name=Paystack%20MCP&description=process%20payments%20with%20Paystack Post-installation, access the extension settings to supply your Paystack confidential key.

Command Line Interface (CLI) Utilization

Install the module globally across your system: bash npm install -g @kohasummons/paystack-mcp Establish your Paystack secret token via an environment variable declaration: bash export PAYSTACK_SECRET_KEY=your_paystack_secret_key_here # For Unix-like systems # OR set PAYSTACK_SECRET_KEY=your_paystack_secret_key_here # For Windows OS Launch the server process: bash paystack-mcp Alternatively, invoke using NPX with the secret key inline: bash PAYSTACK_SECRET_KEY=your_paystack_secret_key_here npx -y @kohasummons/paystack-mcp

Configuration for Cursor IDE

Incorporate the following object into your Cursor MCP configuration manifest: { "mcpServers": { "paystack-mcp": { "command": "npx", "args": ["-y", "@kohasummons/paystack-mcp"], "env": { "PAYSTACK_SECRET_KEY": "your_paystack_secret_key_here" } } } }

Docker Container Deployment

You can instantiate the Paystack MCP intermediary via Dockerized containers: ### Image Construction bash docker-compose build ### Independent Server Operation bash docker-compose up -d #### Configuration for Cursor Environment Populate your `.cursor/mcp.json` with: { "mcpServers": { "paystack-mcp": { "command": "docker", "args": [ "run", "--rm", "-i", "-e", "PAYSTACK_SECRET_KEY=your_paystack_secret_key_here", "kohasummons/paystack-mcp" ] } } } #### Configuration for Claude Desktop { "mcpServers": { "paystack-mcp": { "command": "docker", "args": [ "run", "--rm", "-i", "-e", "PAYSTACK_SECRET_KEY=your_paystack_secret_key_here", "kohasummons/paystack-mcp" ] } } } Consult [DOCKER.md](DOCKER.md) for comprehensive instructions regarding Docker usage.

Available Tools

Product Catalog Management

Tool Name	Functionality Synopsis	Illustrative Query
create_product	Provision a new merchandise item	"Establish a product designated 'Enterprise Tier' priced at 5000 Naira"
list_products	Retrieve a listing of all defined products	"Present every item currently listed in my Paystack repository"
get_product	Fetch detailed specifications for a singular product	"Obtain the attributes for product identifier 12345"
update_product	Modify parameters of an extant product entity	"Adjust the monetary value of product ID 12345 to 6000 Naira"

Client Profile Administration

Tool Name	Functionality Synopsis	Illustrative Query
create_customer	Onboard a new client entity	"Register a new client with the electronic mail address john@example.com"
list_customers	Enumerate all registered clientele	"Display my entire roster of clients"
get_customer	Retrieve a specific client's profile data	"Fetch details pertaining to customer email john@example.com"
update_customer	Revise information associated with a client	"Modify Mr. Doe's contact telephone number to +2341234567890"
validate_customer	Confirm client identity using bank credentials	"Certify client CUS_123 utilizing their associated bank account information"
set_customer_risk_action	Impose transaction restrictions (allow/deny) on a client	"Flag client CUS_123 for transaction denial"

Transaction Processing

Tool Name	Functionality Synopsis	Illustrative Query
initialize_transaction	Initiate the commencement of a financial transfer	"Start a transfer of 5000 Naira for client john@example.com"
verify_transaction	Ascertain the final status of a payment record	"Confirm the settlement state of transaction reference TR_123456"
fetch_transaction	Retrieve comprehensive data for a specific transaction record	"Acquire the full record for transaction identifier 12345"
list_transactions	Fetch filtered sequences of past transactions	"Summarize all successful transactions processed within the last thirty days"
charge_authorization	Debit a client's stored payment instrument	"Debit client john@example.com 5000 Naira using their saved payment method"
partial_debit	Apply a partial charge against an authorized instrument	"Execute a partial debit of 3000 Naira from john@example.com's stored card"
deactivate_authorization	Revoke an active payment mandate	"Cancel the saved payment method linked to authorization code AUTH_123"
transaction_totals	Obtain aggregated revenue figures	"What is the cumulative revenue received in my account over the preceding month?"
export_transactions	Generate a downloadable list of transaction data	"Generate a data export containing all transactions from January 2023"

Institutional Data Retrieval

Tool Name	Functionality Synopsis	Illustrative Query
list_banks	Retrieve supported financial institutions list	"List every supported banking entity within Nigeria"
list_countries	Retrieve supported operational geographies	"Which sovereign nations does the Paystack platform service?"
list_states	Retrieve regional subdivisions for a nation	"Provide a directory of all administrative regions within Nigeria relevant for address validation"

Development & Extension

We actively encourage community input to enhance this repository and integrate remaining Paystack API functionalities as callable tools. Potential areas for expansion include:

• Hosted Payment Pages
• Sub-ledger Accounts
• Recurring Payment Structures (Plans)
• Automated Billing Sequences (Subscriptions)
• Apple Pay Gateway Integration
• Virtual Account Provisioning
• Billing Statements (Invoices)
• Payment Reversals (Refunds)
• And numerous others!

Refer to CONTRIBUTING.md for detailed guidelines on contributing, covering: - Setting up the necessary development environment - Protocol for implementing novel tool functions - Adherence to established coding conventions - The procedure for submitting Pull Requests

---

Local Development Workflow

To facilitate active development on this service component:

1. Obtain a local copy of the repository.
2. Install required packages: npm install
3. Compile the project artifacts: npm run build
4. Launch the Server Inspector for diagnostics: npm run dev:debug

You must configure your Paystack secret credential as an environment variable, typically via a local .env file:

bash

Create .env file in the root directory

echo "PAYSTACK_SECRET_KEY=your_paystack_secret_key_here" > .env

Troubleshooting & Debugging

For deep inspection of server behavior, utilize the MCP Inspector Tool.

Initially, compile the server assets:

npm run build

Execute the following command in your terminal session:

bash

Initiate both the MCP Inspector and the Paystack server

npm run dev:debug

Supply your PAYSTACK_SECRET_KEY within the Inspector interface to commence debugging operations.

Containerized Execution

Details on building and operating this system using Docker are provided in DOCKER.md.

Licensing

This project is distributed under the MIT License.

== Contextual Background: Business Management Systems == Business management instrumentation encompasses all methodologies, software solutions, control mechanisms, computational frameworks, and protocols utilized by organizations to successfully navigate evolving market dynamics, maintain a competitive edge, and systematically elevate operational performance.

== Functional Classification == Instrumentation can be segmented based on the organizational domain they serve, such as tools dedicated to strategic foresight, workflow optimization, record-keeping, human capital management, or governance and oversight.

By functional aspect, these tools broadly address:

• Mechanisms for data acquisition and input validation across all departments.
• Systems designed for monitoring and optimizing core operational procedures.
• Platforms for data aggregation and informing executive decision-making.

The contemporary landscape of business tools has been radically transformed by rapid technological proliferation, frequently leading to complexity in selecting optimal solutions for specific corporate needs. This is driven by continuous pressure to reduce expenditures, maximize revenue streams, deeply understand client requirements, and precisely deliver products meeting those needs.

In this environment, leadership must adopt a strategic lens when evaluating business instrumentation, favoring tailored adaptation over the mere adoption of the newest trending technology. Improper selection and forced implementation often result in organizational instability. Therefore, management systems must be chosen deliberately and subsequently customized to fit the enterprise's intrinsic requirements.

== Popular Instruments (Historical Context) == Data from a 2013 Bain & Company assessment indicated global usage patterns for business tools, reflecting regional priorities influenced by economic conditions. The top ten categories identified included:

• Strategic Planning Frameworks
• Client Relationship Management (CRM)
• Personnel Satisfaction Measurement (Surveys)
• Benchmarking Analysis
• Balanced Scorecard Implementation
• Core Competency Identification
• Outsourcing Strategy
• Organizational Change Management Programs
• Supply Chain Logistics Optimization
• Mission and Vision Definition
• Market Segmentation Analysis
• Total Quality Management (TQM)

== Business Software Applications == Software solutions or integrated suites employed by personnel to execute diverse corporate functions are termed 'business applications.' These applications aim to augment productivity, quantify performance metrics, and execute varied enterprise tasks with precision. The progression moved from early Management Information Systems (MIS) to expansive Enterprise Resource Planning (ERP) systems, followed by the incorporation of CRM functionalities, culminating in the current paradigm of cloud-native business management platforms.

While a direct link exists between IT investment and organizational success, value realization hinges on two crucial factors: the efficacy of the deployment process and the judicious selection and subsequent customization of the underlying technological assets.

== Instruments Tailored for Small and Medium Enterprises (SMEs) == SME-focused instruments are vital as they offer scalable mechanisms to conserve valuable operational resources...