smbc-mcp-server 1.0.0 → 1.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +86 -53
  2. package/package.json +9 -3
package/README.md CHANGED
@@ -1,72 +1,81 @@
1
1
  # SMBC マルチペイメントサービス MCP サーバー
2
2
 
3
- SMBC マルチペイメントサービス（OpenAPI タイプ）の API 仕様を MCP リソースとして公開するサーバーです。
4
-
5
- Cursor・Claude Desktop などの MCP クライアントから API 仕様を参照できるようになります。クローンやビルドは不要で、`npx` で即利用できます。
3
+ Cursor・Claude Desktop にこの MCP サーバーを登録すると、エージェントが SMBC マルチペイメントサービスの API 仕様を参照できるようになります。
6
4
 
7
5
  公式ドキュメント: https://docs.smbc-gp.co.jp/mulpay/docs/introduction/overview
8
6
 
9
7
  ---
10
8
 
11
- ## セットアップ
9
+ ## 目次
10
+
11
+ 1. [Cursor への登録](#1-cursor-への登録)
12
+ 2. [Claude Desktop への登録](#2-claude-desktop-への登録)
13
+ 3. [リソースの使い方](#3-リソースの使い方)
14
+ 4. [エージェントへの質問例](#4-エージェントへの質問例)
15
+ 5. [API が更新されたとき](#5-apiが更新されたとき)
16
+ 6. [注意事項](#6-注意事項)
17
+
18
+ ---
19
+
20
+ ## 1. Cursor への登録
21
+
22
+ Cursor には**グローバル設定**（全プロジェクト共通）と**プロジェクト設定**（リポジトリ固有）の2種類があります。
12
23
 
13
- ### Cursor への登録
24
+ ### グローバル設定
14
25
 
15
- グローバル設定（`~/.cursor/mcp.json`）またはプロジェクト設定（`.cursor/mcp.json`）に以下を追加します。
26
+ `~/.cursor/mcp.json` を開き（存在しない場合は新規作成）、以下を追記します。
16
27
 
17
28
  ```json
18
29
  {
19
30
  "mcpServers": {
20
31
  "smbc-api-docs": {
21
32
  "command": "npx",
22
- "args": ["smbc-mcp-server"],
23
- "env": {
24
- "SMBC_SHOP_ID": "your_shop_id",
25
- "SMBC_SHOP_PASSWORD": "your_shop_password"
26
- }
33
+ "args": ["smbc-mcp-server"]
27
34
  }
28
35
  }
29
36
  }
30
37
  ```
31
38
 
32
- ### Claude Desktop への登録
39
+ ### プロジェクト設定
40
+
41
+ プロジェクトルートに `.cursor/mcp.json` を作成し、同じ内容を記載します。プロジェクト設定はグローバル設定より優先されます。
42
+
43
+ ### 有効化の確認
44
+
45
+ 1. Cursor を再起動します
46
+ 2. **Settings → MCP** を開き、`smbc-api-docs` サーバーが緑色（有効）になっていることを確認します
47
+ 3. Agent モードでエージェントが自動的にリソースを参照します
33
48
 
34
- `~/Library/Application Support/Claude/claude_desktop_config.json` に以下を追加します。
49
+ > **注意:** Cursor では MCP は **Agent モード**でのみ利用できます。
50
+
51
+ ---
52
+
53
+ ## 2. Claude Desktop への登録
54
+
55
+ `~/Library/Application Support/Claude/claude_desktop_config.json` を開き、以下を追記します。
35
56
 
36
57
  ```json
37
58
  {
38
59
  "mcpServers": {
39
60
  "smbc-api-docs": {
40
61
  "command": "npx",
41
- "args": ["smbc-mcp-server"],
42
- "env": {
43
- "SMBC_SHOP_ID": "your_shop_id",
44
- "SMBC_SHOP_PASSWORD": "your_shop_password"
45
- }
62
+ "args": ["smbc-mcp-server"]
46
63
  }
47
64
  }
48
65
  }
49
66
  ```
50
67
 
51
- 設定後に MCP クライアントを再起動すると利用可能になります。
68
+ 設定後に **Claude Desktop を再起動**すると利用可能になります。
52
69
 
53
70
  ---
54
71
 
55
- ## 環境変数
56
-
57
- | 変数名 | 必須 | 説明 | デフォルト |
58
- |---|---|---|---|
59
- | `SMBC_SHOP_ID` | 必須 | ショップID | - |
60
- | `SMBC_SHOP_PASSWORD` | 必須 | ショップパスワード | - |
61
- | `SMBC_OPENAPI_PATH` | 任意 | OpenAPI ファイルのパス | パッケージ同梱の `openapi-type.yml` |
62
-
63
- ---
72
+ ## 3. リソースの使い方
64
73
 
65
- ## 利用できるリソース
74
+ このサーバーは2段階のリソースを提供します。
66
75
 
67
- ### `smbc://index`
76
+ ### Step 1: `smbc://index` で API 一覧を取得
68
77
 
69
- 全 API オペレーションの一覧を返します。
78
+ 全オペレーションの `operationId`・メソッド・パス・summary の一覧を返します。
70
79
 
71
80
  ```json
72
81
  {
@@ -77,45 +86,69 @@ Cursor・Claude Desktop などの MCP クライアントから API 仕様を参
77
86
  }
78
87
  ```
79
88
 
80
- ### `smbc://operation/{operationId}`
89
+ ### Step 2: `smbc://operation/{operationId}` で詳細を取得
81
90
 
82
- 特定の API オペレーションの詳細を返します。
91
+ 特定オペレーションの完全な情報（`description`・`requestSchema`・`requiredFields`・`requiresAuth` 等）を返します。
83
92
 
84
93
  ```
85
94
  smbc://operation/token
86
95
  smbc://operation/creditCharge
96
+ smbc://operation/orderInquiry
87
97
  ```
88
98
 
89
- レスポンスには `description`・`requestSchema`・`requiredFields`・`requiresAuth` などの完全な情報が含まれます。
99
+ エージェントはこの2段階のフローで API 仕様を把握し、正確な情報を回答します。
100
+
101
+ ---
102
+
103
+ ## 4. エージェントへの質問例
104
+
105
+ ### API 仕様の確認
106
+
107
+ > 「SMBC API でトークンを取得する方法を教えて」
108
+
109
+ > 「creditCharge の必須パラメータは何ですか？」
110
+
111
+ > 「認証が不要な API の一覧を教えて」
112
+
113
+ > 「orderInquiry の requestSchema を確認して」
90
114
 
91
- 情報が見つからない場合は公式ドキュメント（https://docs.smbc-gp.co.jp/mulpay/docs/introduction/overview）への案内が返されます。
115
+ ### 実装サポート
116
+
117
+ > 「クレジットカード決済の API を呼び出す Python コードを書いて」
118
+
119
+ > 「取引照会の API リクエストの例を見せて」
92
120
 
93
121
  ---
94
122
 
95
- ## API が更新された場合
123
+ ## 5. API が更新されたとき
124
+
125
+ SMBC が API を更新した場合、以下のいずれかで対応します。
126
+
127
+ ### A. パッケージの新バージョンを待つ（推奨）
128
+
129
+ 本パッケージが更新されると、`npx smbc-mcp-server` が自動的に最新版を使用します。
130
+
131
+ ### B. 最新の YML ファイルを直接指定する
96
132
 
97
- 1. 新しいバージョンの本パッケージが公開されるまで待つ
98
- 2. または `SMBC_OPENAPI_PATH` 環境変数で最新の YML ファイルを直接指定する
133
+ [公式サイト](https://docs.smbc-gp.co.jp/mulpay/apis/openapi-type/intro) から最新の `openapi-type.yml` をダウンロードし、環境変数で指定します。
99
134
 
100
135
  ```json
101
- "env": {
102
- "SMBC_SHOP_ID": "your_shop_id",
103
- "SMBC_SHOP_PASSWORD": "your_shop_password",
104
- "SMBC_OPENAPI_PATH": "/path/to/latest/openapi-type.yml"
136
+ {
137
+ "mcpServers": {
138
+ "smbc-api-docs": {
139
+ "command": "npx",
140
+ "args": ["smbc-mcp-server"],
141
+ "env": {
142
+ "SMBC_OPENAPI_PATH": "/path/to/latest/openapi-type.yml"
143
+ }
144
+ }
145
+ }
105
146
  }
106
147
  ```
107
148
 
108
149
  ---
109
150
 
110
- ## 開発者向け
151
+ ## 6. 注意事項
111
152
 
112
- ```bash
113
- # 依存インストール
114
- npm install
115
-
116
- # ビルド
117
- npm run build
118
-
119
- # テスト
120
- npm test
121
- ```
153
+ - このサーバーは **API 仕様の参照のみ**を提供します。実際の API 呼び出しは行いません。
154
+ - Agent モードで質問する際、エージェントが自動的に MCP リソースを参照します。手動での操作は不要です。
package/package.json CHANGED
@@ -1,8 +1,14 @@
1
1
  {
2
2
  "name": "smbc-mcp-server",
3
- "version": "1.0.0",
3
+ "version": "1.0.1",
4
4
  "description": "SMBC マルチペイメントサービス OpenAPI仕様をMCPリソースとして公開するサーバー",
5
- "keywords": ["mcp", "smbc", "openapi", "payment", "modelcontextprotocol"],
5
+ "keywords": [
6
+ "mcp",
7
+ "smbc",
8
+ "openapi",
9
+ "payment",
10
+ "modelcontextprotocol"
11
+ ],
6
12
  "author": "",
7
13
  "license": "ISC",
8
14
  "type": "module",
@@ -27,4 +33,4 @@
27
33
  "typescript": "^6.0.3",
28
34
  "vitest": "^4.1.7"
29
35
  }
30
- }
36
+ }