
WooCommerce MCP サーバー
Windows、macOS、Linux に対応した、WooCommerce 連携用の Model Context Protocol(MCP)サーバーです。
概要
この MCP サーバーを使用すると、WordPress REST API を通じて WooCommerce ストアとやり取りできます。JSON-RPC 2.0 プロトコルを使用して、商品、注文、顧客、配送、税金、割引、ストア設定のあらゆる側面を管理するための包括的なツールを提供します。
関連プロジェクト
WooCommerce ストアを 8 億人以上の ChatGPT ユーザーに紹介しましょう! WooCommerce ChatGPT App をご覧ください。MCP と ChatGPT SDK を使用して構築されたビジュアルショッピングアシスタントで、商品、画像、価格、説明を美しい UI で表示します。ChatGPT 内で商品を閲覧、検索、絞り込み、シームレスにストアへ移動できます。
インストール - WooCommerce MCP サーバー
- リポジトリをクローンします
- 依存関係をインストールします:
npm install
- プロジェクトをビルドします:
npm run build
設定
認証情報用の環境変数を指定して、MCP 設定ファイルにサーバーを追加します:
{
"mcpServers": {
"woocommerce": {
"command": "node",
"args": ["path/to/build/index.js"],
"env": {
"WORDPRESS_SITE_URL": "https://your-wordpress-site.com",
"WOOCOMMERCE_CONSUMER_KEY": "your-woocommerce-consumer-key",
"WOOCOMMERCE_CONSUMER_SECRET": "your-woocommerce-consumer-secret",
"WORDPRESS_USERNAME": "your-wordpress-username",
"WORDPRESS_PASSWORD": "your-wordpress-password"
}
}
}
}
環境変数
WooCommerce API アクセスに必要:
WORDPRESS_SITE_URL:WordPress サイトの URL(WooCommerce は WordPress プラグインです)
WOOCOMMERCE_CONSUMER_KEY:WooCommerce REST API のコンシューマーキー
WOOCOMMERCE_CONSUMER_SECRET:WooCommerce REST API のコンシューマーシークレット
WordPress API メソッドのみで必要:
WORDPRESS_USERNAME:適切な権限を持つ WordPress ユーザー名
WORDPRESS_PASSWORD:認証用の WordPress パスワード
環境変数を使用しない場合は、リクエストパラメーターでこれらの認証情報を指定することもできます。
認証オプション
WooCommerce 認証
WooCommerce API にアクセスするには、WordPress ダッシュボードの WooCommerce → 設定 → 高度な設定 → REST API で生成できるコンシューマーキーが必要です。
WordPress 認証
WordPress 固有のメソッド(投稿の管理など)には、次の情報が必要です:
- 基本認証用のユーザー名とパスワード
- サイトで WordPress REST API が有効になっていること
API メソッド
このサーバーは、WordPress と WooCommerce の両方の API メソッドに対応しています。以下は、カテゴリ別にまとめた利用可能なメソッドの一覧です:
WordPress コンテンツ管理
これらのメソッドには WordPress のユーザー名とパスワードが必要で、WooCommerce API には依存しません。
| メソッド | 説明 |
|---|
create_post | WordPress の新しい投稿を作成 |
get_posts | WordPress の投稿を取得 |
update_post | 既存の WordPress 投稿を更新 |
get_post_meta | 投稿のメタデータを取得 |
update_post_meta | 投稿のメタデータを更新 |
create_post_meta | 投稿のメタデータを作成 |
delete_post_meta | 投稿のメタデータを削除 |
WooCommerce 商品
| メソッド | 説明 |
|---|
get_products | 商品一覧を取得 |
get_product | ID で単一の商品を取得 |
create_product | 新しい商品を作成 |
update_product | 既存の商品を更新 |
delete_product | 商品を削除 |
get_product_meta | 商品のメタデータを取得 |
create_product_meta | 商品のメタデータを作成/更新 |
update_product_meta | 商品のメタデータを更新(create のエイリアス) |
delete_product_meta | 商品のメタデータを削除 |
商品カテゴリー
| メソッド | 説明 |
|---|
get_product_categories | 商品カテゴリーを取得 |
get_product_category | 単一の商品カテゴリーを取得 |
create_product_category | 新しい商品カテゴリーを作成 |
update_product_category | 商品カテゴリーを更新 |
delete_product_category | 商品カテゴリーを削除 |
商品タグ
| メソッド | 説明 |
|---|
get_product_tags | 商品タグを取得します |
get_product_tag | 単一の商品タグを取得します |
create_product_tag | 新しい商品タグを作成します |
update_product_tag | 商品タグを更新します |
delete_product_tag | 商品タグを削除します |
商品属性
| メソッド | 説明 |
|---|
get_product_attributes | 商品属性を取得します |
get_product_attribute | 単一の商品属性を取得します |
create_product_attribute | 新しい商品属性を作成します |
update_product_attribute | 商品属性を更新します |
delete_product_attribute | 商品属性を削除します |
get_attribute_terms | 属性タームを取得します |
get_attribute_term | 単一の属性タームを取得します |
create_attribute_term | 新しい属性タームを作成します |
update_attribute_term | 属性タームを更新します |
delete_attribute_term | 属性タームを削除します |
商品バリエーション
| メソッド | 説明 |
|---|
get_product_variations | 商品バリエーションを取得します |
get_product_variation | 単一の商品バリエーションを取得します |
create_product_variation | 新しい商品バリエーションを作成します |
update_product_variation | 商品バリエーションを更新します |
delete_product_variation | 商品バリエーションを削除します |
商品レビュー
| メソッド | 説明 |
|---|
get_product_reviews | 商品レビューを取得します |
get_product_review | 単一の商品レビューを取得します |
create_product_review | 新しい商品レビューを作成します |
update_product_review | 商品レビューを更新します |
delete_product_review | 商品レビューを削除します |
WooCommerce の注文
| メソッド | 説明 |
|---|
get_orders | 注文の一覧を取得します |
get_order | ID で単一の注文を取得します |
create_order | 新しい注文を作成します |
update_order | 既存の注文を更新します |
delete_order | 注文を削除します |
get_order_meta | 注文のメタデータを取得します |
create_order_meta | 注文のメタデータを作成/更新します |
update_order_meta | 注文のメタデータを更新します(create のエイリアス) |
delete_order_meta | 注文のメタデータを削除します |
注文メモ
| メソッド | 説明 |
|---|
get_order_notes | 注文メモを取得します |
get_order_note | 単一の注文メモを取得します |
create_order_note | 新しい注文メモを作成します |
delete_order_note | 注文メモを削除します |
注文の返金
| メソッド | 説明 |
|---|
get_order_refunds | 注文の返金を取得します |
get_order_refund | 単一の注文の返金を取得します |
create_order_refund | 新しい注文の返金を作成します |
delete_order_refund | 注文の返金を削除します |
WooCommerce の顧客
| メソッド | 説明 |
|---|
get_customers | 顧客の一覧を取得します |
get_customer | ID で単一の顧客を取得します |
create_customer | 新しい顧客を作成します |
update_customer | 既存の顧客を更新します |
delete_customer | 顧客を削除します |
get_customer_meta | 顧客のメタデータを取得します |
create_customer_meta | 顧客のメタデータを作成/更新します |
update_customer_meta | 顧客のメタデータを更新します(create のエイリアス) |
delete_customer_meta | 顧客のメタデータを削除します |
配送
| メソッド | 説明 |
|---|
get_shipping_zones | 配送ゾーンを取得 |
get_shipping_zone | 単一の配送ゾーンを取得 |
create_shipping_zone | 新しい配送ゾーンを作成 |
update_shipping_zone | 配送ゾーンを更新 |
delete_shipping_zone | 配送ゾーンを削除 |
get_shipping_methods | 配送方法を取得 |
get_shipping_zone_methods | ゾーンの配送方法を取得 |
create_shipping_zone_method | ゾーンに新しい配送方法を作成 |
update_shipping_zone_method | ゾーンの配送方法を更新 |
delete_shipping_zone_method | ゾーンから配送方法を削除 |
get_shipping_zone_locations | 配送ゾーンの地域を取得 |
update_shipping_zone_locations | 配送ゾーンの地域を更新 |
税金
| メソッド | 説明 |
|---|
get_tax_classes | 税区分を取得 |
create_tax_class | 新しい税区分を作成 |
delete_tax_class | 税区分を削除 |
get_tax_rates | 税率を取得 |
get_tax_rate | 単一の税率を取得 |
create_tax_rate | 新しい税率を作成 |
update_tax_rate | 税率を更新 |
delete_tax_rate | 税率を削除 |
割引/クーポン
| メソッド | 説明 |
|---|
get_coupons | クーポンを取得 |
get_coupon | 単一のクーポンを取得 |
create_coupon | 新しいクーポンを作成 |
update_coupon | クーポンを更新 |
delete_coupon | クーポンを削除 |
決済ゲートウェイ
| メソッド | 説明 |
|---|
get_payment_gateways | 決済ゲートウェイを取得 |
get_payment_gateway | 単一の決済ゲートウェイを取得 |
update_payment_gateway | 決済ゲートウェイを更新 |
レポート
| メソッド | 説明 |
|---|
get_sales_report | 売上レポートを取得 |
get_products_report | 商品レポートを取得 |
get_orders_report | 注文レポートを取得 |
get_categories_report | カテゴリーレポートを取得 |
get_customers_report | 顧客レポートを取得 |
get_stock_report | 在庫レポートを取得 |
get_coupons_report | クーポンレポートを取得 |
get_taxes_report | 税金レポートを取得 |
設定
| メソッド | 説明 |
|---|
get_settings | すべての設定を取得 |
get_setting_options | 設定のオプションを取得 |
update_setting_option | 設定オプションを更新 |
システムステータス
| メソッド | 説明 |
|---|
get_system_status | システムステータスを取得 |
get_system_status_tools | システムステータスツールを取得 |
run_system_status_tool | システムステータスツールを実行 |
データ
| メソッド | 説明 |
|---|
get_data | ストアデータを取得 |
get_continents | 大陸データを取得 |
get_countries | 国データを取得 |
get_currencies | 通貨データを取得 |
get_current_currency | 現在の通貨を取得 |
メソッドのパラメーター
すべてのメソッドで、同様のパラメーター構成が使われます。以下に例を示します。
すべてのメソッドに共通するパラメーター
siteUrl:(環境変数で設定されている場合は省略可)WordPress サイトの URL
WooCommerce メソッドの追加パラメーター
consumerKey:(環境変数で設定されている場合は省略可)WooCommerce のコンシューマーキー
consumerSecret:(環境変数で設定されている場合は省略可)WooCommerce のコンシューマーシークレット
WordPress メソッドの追加パラメーター
username:(環境変数で設定されている場合は省略可)WordPress のユーザー名
password:(環境変数で設定されている場合は省略可)WordPress のパスワード
使用例
WordPress API の例
{
"jsonrpc": "2.0",
"id": 1,
"method": "create_post",
"params": {
"siteUrl": "https://your-wordpress-site.com",
"username": "your-wordpress-username",
"password": "your-wordpress-password",
"title": "My New Blog Post",
"content": "This is the content of my new blog post.",
"status": "publish"
}
}
WooCommerce 商品の例
{
"jsonrpc": "2.0",
"id": 1,
"method": "get_products",
"params": {
"perPage": 20,
"page": 1,
"filters": {
"category": 19,
"status": "publish"
}
}
}
商品作成の例
{
"jsonrpc": "2.0",
"id": 1,
"method": "create_product",
"params": {
"productData": {
"name": "Premium T-Shirt",
"type": "simple",
"regular_price": "29.99",
"description": "Comfortable cotton t-shirt, available in various sizes.",
"short_description": "Premium quality t-shirt.",
"categories": [
{
"id": 19
}
],
"images": [
{
"src": "http://example.com/wp-content/uploads/2022/06/t-shirt.jpg"
}
]
}
}
}
商品メタデータの例
{
"jsonrpc": "2.0",
"id": 1,
"method": "create_product_meta",
"params": {
"productId": 456,
"metaKey": "_custom_product_field",
"metaValue": {
"special_attribute": "value",
"another_attribute": 42
}
}
}
注文メタデータの例
{
"jsonrpc": "2.0",
"id": 1,
"method": "create_order_meta",
"params": {
"orderId": 789,
"metaKey": "_delivery_instructions",
"metaValue": "Leave package at the back door"
}
}
セキュリティに関する注意
WooCommerce REST API にアクセスするには、API キーを生成する必要があります。WordPress ダッシュボードの WooCommerce → 設定 → 高度な設定 → REST API から作成できます。
要件
- Node.js 20.0.0 以上
- WooCommerce プラグインがインストールされた WordPress サイト
- WooCommerce REST API キー
ライセンス
MIT License - 詳細は LICENSE ファイルをご覧ください