Yeepay Mcp
About
The Yeepay MCP service provides integration with Yeepay services via the Model Context Protocol (MCP).
Details
- Author
- yop-platform
- Downloads
- 157
- Categories
- Other
Jump to
- Create Yeepay webpage payment orders with required parameters
- Query the status of a Yeepay payment order by order ID
- Supports local development, Docker, and npx execution
- Configurable via environment variables or an .env file
- Integrates seamlessly with MCP‑compatible tools (e.g., Cline)
Setting up with Highlight
This MCP is not yet compatible with Highlight’s one-click setup. However, you can still use it with Highlight by following these steps:
- Download and install Highlight from highlightai.com/download
- Navigate to the plugins tab and select "Add Custom Plugin"
-
Configure the plugin with the settings below
Plugin Name
Yeepay McpCommand (node, npx, python, etc.)Please refer to the README for specific instructions on how to obtain API keys or other required environment variables.
- Enable "Start Automatically" if you want the plugin to start when Highlight launches
From the repository
Install Node.js and pnpm/npm, clone the repository, run npm install (or pnpm install), and copy .env.example to .env with your Yeepay merchant credentials. Then start the service via npm run dev (development) or npm start (production). You can also run it with Docker, invoke via npx, or integrate it into an MCP client like Cline.
Claude Desktop / Cursor
Paste into your MCP client config file to install this server.
{
"mcpServers": {
"yeepay mcp": {
"yeepay-mcp": {
"command": "npx",
"args": [
"yeepay-mcp"
],
"env": {
"YOP_PARENT_MERCHANT_NO": "\u60a8\u7684\u7236\u5546\u6237\u7f16\u53f7",
"YOP_MERCHANT_NO": "\u60a8\u7684\u5546\u6237\u7f16\u53f7",
"YOP_APP_PRIVATE_KEY": "\u60a8\u7684\u79c1\u94a5",
"YOP_APP_KEY": "\u60a8\u7684\u5e94\u7528AppKey",
"YOP_NOTIFY_URL": "https://\u60a8\u7684\u57df\u540d/yeepay/notify"
},
"disabled": false,
"alwaysAllow": []
}
}
}
}McpServers
{
"yeepay-mcp": {
"command": "npx",
"args": [
"yeepay-mcp"
],
"env": {
"YOP_PARENT_MERCHANT_NO": "\u60a8\u7684\u7236\u5546\u6237\u7f16\u53f7",
"YOP_MERCHANT_NO": "\u60a8\u7684\u5546\u6237\u7f16\u53f7",
"YOP_APP_PRIVATE_KEY": "\u60a8\u7684\u79c1\u94a5",
"YOP_APP_KEY": "\u60a8\u7684\u5e94\u7528AppKey",
"YOP_NOTIFY_URL": "https://\u60a8\u7684\u57df\u540d/yeepay/notify"
},
"disabled": false,
"alwaysAllow": []
}
}Features
- create_webpage_yeepay_payment: Create Yeepay webpage payment order
- Required parameters: orderId (string), amount (number), goodsName (string), userIp (string)
- query_yeepay_payment_status: Query Yeepay payment order status
- Required parameters: orderId (string)
Prerequisites
- Node.js (LTS version recommended)
- pnpm (or npm)
Installation and Configuration
1. Installation
# Clone the repository
git clone https://github.com/yop-platform/yeepay-mcp.git
cd yeepay-mcp
Install dependencies
npm install
or
pnpm install
2. Configuration
Copy .env.example to .env and configure the following environment variables:
YOP_PARENT_MERCHANT_NO=Your parent merchant number
YOP_MERCHANT_NO=Your merchant number
YOP_APP_PRIVATE_KEY=Your private key
YOP_APP_KEY=Your application AppKey
YOP_NOTIFY_URL=https://your-domain.com/yeepay/notify
Usage
There are several ways to run and use this MCP service:
1. Run Locally
Development Mode (with hot-reloading)
npm run dev
or
pnpm run dev
Production Mode
# Build the project
npm run build
or
pnpm run build
Start the service
npm start
or
pnpm start
2. Run with Docker
# Build the image
docker build -t yeepay-mcp .
Run the container (ensure the .env file exists)
docker run -p 3000:3000 --env-file .env yeepay-mcp
3. Call via npx
This project supports direct invocation via npx.
Local Project Invocation (Before Publishing)
Run in the project directory:
# First, build the project
npm run build
Use npx to call the local package
npx . [arguments]
Or use the full path:
npx /absolute/path/to/yeepay-mcp [arguments]
Passing Arguments
You can pass arguments to the npx command:
npx . --port 3001 --host 0.0.0.0
Invocation After Publishing
Once the project is published to the npm registry, you can use it directly:
npx yeepay-mcp [arguments]
And you can specify a version:
npx yeepay-mcp@0.1.0 [arguments]
4. Integrate as an MCP Service
This service can be integrated into tools that support MCP (like Cline).
Startup Methods
Method 1: Package Runner (Recommended)
pnpm dlx yeepay-mcp
or
npx yeepay-mcp
_(Note: This method is available after the package is published to npm)_
Method 2: Node (Local Development/Direct Path)
node /path/to/yeepay-mcp/dist/index.js
Important Note: Regardless of the startup method, the service needs access to the .env file in the working directory at runtime to obtain configuration.
Configure in Cline
Configure this service in Cline's MCP settings file (cline_mcp_settings.json).
Configure using Node (Local Development or Specific Path):
"yeepay-mcp": {
"command": "node",
"args": [
"/path/to/yeepay-mcp/dist/index.js" // Replace with the actual absolute path
],
"env": { // Alternatively, place the configuration in the .env file and ensure the service can read it
"YOP_PARENT_MERCHANT_NO": "Your parent merchant number",
"YOP_MERCHANT_NO": "Your merchant number",
"YOP_APP_PRIVATE_KEY": "Your private key",
"YOP_APP_KEY": "Your application AppKey",
"YOP_NOTIFY_URL": "https://your-domain.com/yeepay/notify"
},
"disabled": false,
"alwaysAllow": []
}
Configure using npx (After Publishing):
"yeepay-mcp": {
"command": "npx",
"args": [
"yeepay-mcp" // Package name
// You can add a version number, e.g., "yeepay-mcp@0.1.0"
// You can also add arguments, e.g., "--port", "3001"
],
"env": { // Same as above, env or .env file
"YOP_PARENT_MERCHANT_NO": "Your parent merchant number",
"YOP_MERCHANT_NO": "Your merchant number",
"YOP_APP_PRIVATE_KEY": "Your private key",
"YOP_APP_KEY": "Your application AppKey",
"YOP_NOTIFY_URL": "https://your-domain.com/yeepay/notify"
},
"disabled": false,
"alwaysAllow": []
}
Sign in to leave a review
Use Google, GitHub, or an email account so ratings stay tied to real people.
No reviews posted yet.
