Yeepay Mcp

Yeepay MCP サービス統合

Yeepay MCP サービスは、Model Context Protocol（MCP）を介して Yeepay サービスとの統合を提供します。

中文ドキュメントを読む

機能

• create_webpage_yeepay_payment：Yeepay のウェブページ決済注文を作成します
  • 必須パラメーター：orderId（string）、amount（number）、goodsName（string）、userIp（string）
• query_yeepay_payment_status：Yeepay の決済注文ステータスを照会します
  • 必須パラメーター：orderId（string）

前提条件

• Node.js（LTS バージョンを推奨）
• pnpm（または npm）

インストールと設定

1. インストール

# Clone the repository
git clone https://github.com/yop-platform/yeepay-mcp.git
cd yeepay-mcp

# Install dependencies
npm install
# or
pnpm install

2. 設定

.env.example を .env にコピーし、以下の環境変数を設定します。

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

使用方法

この MCP サービスを実行して使用するには、いくつかの方法があります。

1. ローカルで実行

開発モード（ホットリロードあり）

npm run dev
# or
pnpm run dev

本番モード

# Build the project
npm run build
# or
pnpm run build

# Start the service
npm start
# or
pnpm start

2. 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. npx 経由で呼び出す

このプロジェクトは、npx 経由で直接呼び出すことができます。

ローカルプロジェクトからの呼び出し（公開前）

プロジェクトディレクトリで実行します。

# First, build the project
npm run build

# Use npx to call the local package
npx . [arguments]

または、フルパスを使用します。

npx /absolute/path/to/yeepay-mcp [arguments]

引数の指定

npx コマンドに引数を渡すことができます。

npx . --port 3001 --host 0.0.0.0

公開後の呼び出し

プロジェクトが npm レジストリに公開されると、直接使用できます。

npx yeepay-mcp [arguments]

バージョンを指定することもできます。

npx [email protected] [arguments]

4. MCP サービスとして統合

このサービスは、Cline などの MCP に対応したツールに統合できます。

起動方法

方法 1：パッケージランナー（推奨）

pnpm dlx yeepay-mcp
# or
npx yeepay-mcp

（注：この方法は、パッケージが npm に公開された後に利用できます）

方法 2：Node（ローカル開発／直接パス）

node /path/to/yeepay-mcp/dist/index.js

重要な注意事項： 起動方法にかかわらず、設定を取得するため、実行時に作業ディレクトリ内の .env ファイルにアクセスできる必要があります。

Cline で設定

Cline の MCP 設定ファイル（cline_mcp_settings.json）でこのサービスを設定します。

Node を使用して設定（ローカル開発または特定のパス）：

"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": []
}

npx を使用して設定（公開後）：

"yeepay-mcp": {
  "command": "npx",
  "args": [
    "yeepay-mcp" // Package name
    // You can add a version number, e.g., "[email protected]"
    // 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": []
}

開発ガイド

開発モード

ホットリロードを有効にして開発します。

pnpm run dev
# or
npm run dev

コミットメッセージの規約

このプロジェクトでは、コミットメッセージの形式に Conventional Commits の仕様を使用しています。各コミットメッセージは、次の形式に従う必要があります。

<type>(<scope>): <subject>

<body>

<footer>

各項目の説明：

• type：コミットの種類を示します。例：feat、fix、docs、style、refactor、test、chore など。
• scope：（任意）コミットの影響範囲を示します。例：core、server、payment、config など。
• subject：コミット内容を簡潔に説明します。命令形、現在形を使用します。
• body：（任意）変更の理由や方法を説明し、コミット内容を詳しく記述します。
• footer：（任意）破壊的変更（BREAKING CHANGE:）や課題のクローズ（Closes #123）に関する情報を記載します。

例：

feat(server): add health check endpoint

Add a new endpoint `/health` to check the health status of the server and its dependencies. This helps with monitoring and deployment verification.

Closes #123
BREAKING CHANGE: The configuration format for database connection has changed.

このプロジェクトでは、コミット前にコミットメッセージが仕様に準拠しているかを自動で確認するため、commitlint と husky が設定されています。コミットメッセージのテンプレートとして .github/commit-template.txt を使用できます。

Git フック

このプロジェクトでは、Git フックの管理に Husky を使用しています。

• pre-commit：lint-staged を実行し、ステージされたファイルのフォーマットと Lint を自動で行います
• commit-msg：commitlint を使用してコミットメッセージを検証し、Conventional Commits の仕様に従っていることを確認します

フックは npm install の実行時に自動的にインストールされるため、Husky をグローバルにインストールする必要はありません。

コードスタイル

このプロジェクトでは、コードスタイルの一貫性を確保・維持するために ESLint と Prettier を使用しています。コードをコミットする前に、lint-staged が自動的に実行され、ステージされたファイルのチェックとフォーマットを行います。リアルタイムでフィードバックを受けられるよう、エディターに対応するプラグインが設定されていることを確認してください。

リリースプロセス

準備

• package.json の version が最新であることを確認します。
• package.json の bin フィールドが dist/index.js を正しく指しており、npx で実行できることを確認します。
• すべての変更がコミットされ、ビルドが成功することを確認します（npm run build）。

npm への手動公開

1. npm にログインします：

   npm login
   

2. 公開します：

   npm publish
   # or if using pnpm
   pnpm publish
   

GitHub Actions による自動公開

このプロジェクトは、GitHub Release の作成時に npm へ自動公開するよう GitHub Actions が設定されています。

1. GitHub Release を作成する：
   • GitHub リポジトリのページで、「Releases」をクリックします。
   • 「Draft a new release」または「Create a new release」をクリックします。
   • package.json のバージョン番号と一致する Tag version を入力します（例：v0.1.0）。
   • 対象ブランチを選択します（通常は main または master）。
   • Release title を入力します（例：Version 0.1.0）。
   • リリースノートを追加します（このバージョンでの変更内容を記述します）。
   • 「Publish release」をクリックします。

GitHub Actions が .github/workflows/release.yml ワークフローを自動的に実行し、パッケージをビルドして npm に公開します。

バージョンの更新

バージョンの手動更新

npm version コマンドを使って、package.json のバージョン番号を更新し、git タグを作成します：

# Patch version update (1.0.0 -> 1.0.1)
npm version patch

# Minor version update (1.0.0 -> 1.1.0)
npm version minor

# Major version update (1.0.0 -> 2.0.0)
npm version major

次に、GitHub にプッシュして手動で公開します：

git push --follow-tags
npm publish

semantic-release による自動バージョン更新（設定されている場合）

プロジェクトで semantic-release が設定されている場合、Conventional Commits に基づいて、通常はバージョン更新と公開が自動化されます：

• fix: コミットでは、パッチバージョンが更新されます。
• feat: コミットでは、マイナーバージョンが更新されます。
• BREAKING CHANGE: を含むコミットでは、メジャーバージョンが更新されます。

メインブランチにマージすると、CI/CD プロセスがバージョンを自動的に算出し、タグを作成してリリースノートを生成し、npm に公開します。

公開後の確認

公開が成功したら、次の方法で確認できます：

1. npm のウェブサイトで、パッケージ名（yeepay-mcp）を検索します。
2. 新しい空のディレクトリで、npx を使ってパッケージのインストールと実行を試します：

   npx yeepay-mcp --help # or other arguments
   

コントリビューションガイド

コントリビューション、バグ報告、改善の提案を歓迎します。次の手順に従ってください：

1. このリポジトリを GitHub アカウントに フォーク します。
2. フォークしたリポジトリをローカルに クローン します：git clone https://github.com/YOUR_USERNAME/yeepay-mcp.git
3. 新しい機能ブランチを作成します：git checkout -b feature/your-amazing-feature
4. コードを変更します。
5. 変更をコミットする際は、コミットメッセージの規約に従ってください：git commit -m 'feat: add some amazing feature'
6. ブランチをフォーク先にプッシュします：git push origin feature/your-amazing-feature
7. 元のリポジトリに、変更内容を説明する Pull Request を作成します。

ライセンス

このプロジェクトは Apache License の下でライセンスされています。詳細は LICENSE ファイルを参照してください。

お問い合わせ

ご質問やご提案がありましたら、以下の方法でご連絡ください：

• GitHub リポジトリで Issue を提出します。
• メールを送信します：[email protected]

ヒント

パッケージが npm レジストリに公開される前に、「package was not found」のようなエラーを避けるため、設定時や呼び出し時にはパッケージ名ではなく、正しい ローカルパス または 絶対パス を使用してください。