Yeepay MCP Service Integration
The Yeepay MCP service provides integration with Yeepay services via the Model Context Protocol (MCP).
Features
create_webpage_yeepay_payment
: Create Yeepay webpage payment order- Required parameters:
orderId
(string),amount
(number),goodsName
(string),userIp
(string)
- Required parameters:
query_yeepay_payment_status
: Query Yeepay payment order status- Required parameters:
orderId
(string)
- Required parameters:
Prerequisites
- Node.js (LTS version recommended)
- pnpm (or npm)
Installation and Configuration
1. Installation
2. Configuration
Copy .env.example
to .env
and configure the following environment variables:
Usage
There are several ways to run and use this MCP service:
1. Run Locally
Development Mode (with hot-reloading)
Production Mode
2. Run with Docker
3. Call via npx
This project supports direct invocation via npx
.
Local Project Invocation (Before Publishing)
Run in the project directory:
Or use the full path:
Passing Arguments
You can pass arguments to the npx
command:
Invocation After Publishing
Once the project is published to the npm registry, you can use it directly:
And you can specify a version:
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)
(Note: This method is available after the package is published to npm)
Method 2: Node (Local Development/Direct Path)
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):
Configure using npx (After Publishing):
Development Guide
Development Mode
Develop with hot-reloading:
Commit Message Convention
This project uses the Conventional Commits specification to format commit messages. Each commit message should follow this format:
Where:
- type: Indicates the type of commit, e.g.,
feat
,fix
,docs
,style
,refactor
,test
,chore
, etc. - scope: (Optional) Indicates the scope affected by the commit, e.g.,
core
,server
,payment
,config
, etc. - subject: Briefly describe the content of the commit, use imperative, present tense.
- body: (Optional) Describe the content of the commit in detail, explaining the reason and method of modification.
- footer: (Optional) Contains information about breaking changes (
BREAKING CHANGE:
) or closing issues (Closes #123
).
Example:
The project has configured commitlint
and husky
to automatically check if commit messages conform to the specification before committing. You can use .github/commit-template.txt
as a template for commit messages.
Git Hooks
This project uses Husky to manage Git hooks:
- pre-commit: Runs
lint-staged
to automatically format and lint staged files - commit-msg: Validates commit messages using
commitlint
to ensure they follow the Conventional Commits specification
The hooks are automatically installed when you run npm install
and do not require any global installation of Husky.
Code Style
This project uses ESLint and Prettier to enforce and maintain code style consistency. Before committing code, lint-staged
will automatically run to check and format staged files. Please ensure your editor is configured with the corresponding plugins for real-time feedback.
Release Process
Preparation
- Ensure the
version
inpackage.json
is up-to-date. - Ensure the
bin
field inpackage.json
correctly points todist/index.js
so thatnpx
can execute it. - Ensure all changes are committed and the build is successful (
npm run build
).
Manual Publishing to npm
- Log in to npm:
- Publish:
Automatic Publishing with GitHub Actions
This project is configured with GitHub Actions to automatically publish to npm when a GitHub Release is created.
- Create GitHub Release:
- On the GitHub repository page, click "Releases".
- Click "Draft a new release" or "Create a new release".
- Enter a Tag version matching the version number in
package.json
(e.g.,v0.1.0
). - Select the target branch (usually
main
ormaster
). - Enter the Release title (e.g.,
Version 0.1.0
). - Add release notes (describe the changes in this version).
- Click "Publish release".
GitHub Actions will automatically trigger the .github/workflows/release.yml
workflow to build and publish the package to npm.
Version Updates
Manual Version Update
Use the npm version
command to update the version number in package.json
and create a git tag:
Then push to GitHub and publish manually:
Automatic Version Update with semantic-release (If Configured)
If the project is configured with semantic-release
, version updates and publishing are usually automated based on Conventional Commits:
fix:
commits trigger a patch version update.feat:
commits trigger a minor version update.- Commits containing
BREAKING CHANGE:
trigger a major version update.
After merging into the main branch, the CI/CD process automatically calculates the version, creates tags, generates release notes, and publishes to npm.
Post-Publish Verification
After successful publishing, you can verify in the following ways:
- Search for your package name (
yeepay-mcp
) on the npm website. - In a new empty directory, try installing and running your package using
npx
:
Contributing Guide
Contributions, bug reports, and improvement suggestions are welcome. Please follow these steps:
- Fork this repository to your GitHub account.
- Clone your forked repository locally:
git clone https://github.com/YOUR_USERNAME/yeepay-mcp.git
- Create a new feature branch:
git checkout -b feature/your-amazing-feature
- Make your code changes.
- Ensure you follow the commit message convention when committing changes:
git commit -m 'feat: add some amazing feature'
- Push your branch to your fork:
git push origin feature/your-amazing-feature
- Create a Pull Request in the original repository describing your changes.
License
This project is licensed under the Apache License. See the LICENSE file for details.
Contact
For questions or suggestions, please contact us via:
- Submit an Issue in the GitHub repository.
- Send an email to: dreambt@gmail.com
Tip
Before the package is published to the npm registry, ensure you use the correct local path or absolute path when configuring or calling it, instead of the package name, to avoid errors like "package was not found".
hybrid server
The server is able to function both locally and remotely, depending on the configuration or use case.
The Yeepay MCP service provides integration with Yeepay services via the Model Context Protocol (MCP).
Related MCP Servers
- AsecurityFlicenseAqualityA Model Context Protocol (MCP) server that provides programmatic access to the Supabase Management API. This server allows AI models and other clients to manage Supabase projects and organizations through a standardized interface.Last updated -867146JavaScript
Upstash MCP Serverofficial
AsecurityAlicenseAqualityModel Context Protocol (MCP) is a new, standardized protocol for managing context between large language models (LLMs) and external systems. In this repository, we provide an installer as well as an MCP Server for Upstash Developer API's.Last updated -163744TypeScriptMIT License- AsecurityFlicenseAqualityAn MCP server that allows users to interact with YNAB data, enabling access to account balances, transactions, and the creation of new transactions through the Model Context Protocol.Last updated -104Python
Shopify Dev MCPofficial
AsecurityAlicenseAqualityModel Context Protocol (MCP) server that interacts with Shopify Dev. This protocol supports various tools to interact with different Shopify APIs.Last updated -42,180460TypeScriptISC License