bitbank-lab-mcp 0.1.2 → 0.1.3

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2026 Toshiki Tanaka
+Copyright (c) 2026 Bitbank, Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1,11 +1,11 @@
 # bitbank-lab-mcp
 
-[![CI](https://github.com/tjackiet/bitbank-lab-mcp/actions/workflows/ci.yml/badge.svg)](https://github.com/tjackiet/bitbank-lab-mcp/actions/workflows/ci.yml)
+[![CI](https://github.com/bitbankinc/bitbank-lab-mcp/actions/workflows/ci.yml/badge.svg)](https://github.com/bitbankinc/bitbank-lab-mcp/actions/workflows/ci.yml)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
 [![npm](https://img.shields.io/npm/v/bitbank-lab-mcp.svg)](https://www.npmjs.com/package/bitbank-lab-mcp)
 [![CodeRabbit Pull Request Reviews](https://img.shields.io/coderabbit/prs/github/tjackiet/bitbank-lab-mcp?utm_source=oss&utm_medium=github&utm_campaign=tjackiet%2Fbitbank-lab-mcp&labelColor=171717&color=FF570A&link=https%3A%2F%2Fcoderabbit.ai&label=CodeRabbit+Reviews)](https://coderabbit.ai)
 
-> bitbank API のデータを使った暗号資産市場分析を、Claude / Cursor / Codex / Gemini CLI など各種 AI クライアントから簡単に実行できる MCP サーバーです。
+> bitbank API のデータを使った暗号資産市場分析を、Claude / Cursor / Codex / Antigravity CLI など各種 AI クライアントから簡単に実行できる MCP サーバーです。
 
 ## はじめにお読みください
 
@@ -17,7 +17,7 @@
 
 bitbank の公開 API から取得した価格・取引データを、指標計算・統合・可視化用データの整形まで行った上で LLM に渡します（必要に応じてサーバー側で SVG 描画も可能）。生データを渡すだけのサーバーとは異なり、各ツールの description に「いつ使うべきか」「他ツールとの使い分け」を明示しているため、LLM が自律的に適切なツールを選択できます。
 
-姉妹プロジェクトとして、同じ bitbank API に対する真逆のアプローチを提供する **CLI** ([bitbank-cli-skills](https://github.com/tjackiet/bitbank-cli-skills)) もあります。
+姉妹プロジェクトとして、同じ bitbank API に対する真逆のアプローチを提供する **CLI** ([bitbank-lab-cli](https://github.com/bitbankinc/bitbank-lab-cli)) もあります。
 
 - **この MCP サーバー** はサーバー側で計算済みの結論を LLM に渡す
 - **CLI** は生データを高速に取得し、LLM 自身に計算させる
@@ -25,7 +25,7 @@ bitbank の公開 API から取得した価格・取引データを、指標計
 指標のパラメータやロジックを完全にカスタマイズしたい場合は CLI 側を、すぐに使えるテクニカル分析・可視化を求める場合は MCP サーバー側を選んでください。
 
 ## 概要
-bitbank の公開 API から価格・板情報・約定履歴・ローソク足データを取得し、以下の分析を実行できます。
+bitbank の公開 API から価格・板情報・約定履歴・ローソク足データを取得し、以下の分析を実行できます。  
 → 全ツールの一覧と使い分けは [docs/tools.md](docs/tools.md) を参照。
 
 #### 取得できるデータ
@@ -45,32 +45,41 @@ bitbank の公開 API から価格・板情報・約定履歴・ローソク足
 
 #### 視覚化
 - Claude.ai の Visualizer で描画するためのコンパクトな整形データを返すツール群
-  - `prepare_chart_data`: ローソク足 + 指標の時系列データ（全指標は計算・シフト適用済み）
-  - `prepare_depth_data`: 板の累積 volume 階段データ（[price, cumulativeVolume][] + mid / spread / band 集計）
+  - `prepare_chart_data`: ローソク足 + 指標の時系列データ
+  - `prepare_depth_data`: 板の累積 volume 階段データ
 - ファイル保存・Cursor 等の非 Visualizer 環境向けに SVG/PNG 形式のチャートも生成可能
   - `render_chart_svg` / `render_depth_svg` / `render_candle_pattern_diagram`
-  - ※ クライアント側で描画可能な場合は `prepare_*` 系を優先。SVG 生成は LLM が自力で描けない環境のフォールバック。
 
 ## クイックスタート
 
 ### 前提条件
-- **Node.js 22 以上**（24 推奨 — CI で検証済み。[公式サイト](https://nodejs.org/) からインストール。`node -v` で確認できます）
+- **Node.js 22 以上**（24 推奨）
+  - `node -v` で確認できます
+  - [公式サイト](https://nodejs.org/) からインストール
 - npm（Node.js に同梱されています）
 - 対応 OS: macOS / Linux / Windows（WSL 含む）
+- **Claude Desktop** アプリを [Claude 公式サイト](https://claude.com/ja/download) からダウンロードしてください
 
-> 本プロジェクトは npm に [`bitbank-lab-mcp`](https://www.npmjs.com/package/bitbank-lab-mcp) として公開されています。**ソースコードのクローンは不要**です（開発したい方向けの手順は[末尾の開発者向けセクション](#開発者向けソースから起動)を参照）。
+> 本プロジェクトは npm に [`bitbank-lab-mcp`](https://www.npmjs.com/package/bitbank-lab-mcp) として公開されています。  
+> **ソースコードのクローンは不要**です（開発したい方向けの手順は[末尾の開発者向けセクション](#開発者向けソースから起動)を参照）。
 
-### 1. Claude Desktop に登録（最短・推奨）
+### 1. Claude Desktop に登録（推奨）
 
-Claude Desktop が最も多くの方が使う想定の MCP クライアントです。`~/Library/Application Support/Claude/claude_desktop_config.json` に設定を追加します。
+Claude Desktop が最も多くの方が使う想定の MCP クライアントです。  
+`~/Library/Application Support/Claude/claude_desktop_config.json` に設定を追加します。
 
-設定方法は2通りあります。**まず方式A を試し、動かない場合に方式B をお試しください。**
+登録方法は2通りあります。**まず npx 方式を試し、動かない場合に絶対パス方式をお試しください。**
 
-#### 方式A：`npx` 経由（推奨）
+#### npx 方式（推奨）
 
-Node.js のバージョンアップで設定を書き換える必要がないため、こちらを推奨します。nvm/volta などのバージョン管理ツールをお使いの方には特におすすめです。
+Node.js のバージョンアップで設定を書き換える必要がないため、こちらを推奨します。  
+nvm/volta などのバージョン管理ツールをお使いの方には特におすすめです。
 
-**Public ツールのみ使う場合（API キー不要）**:
+用途に応じて **A〜C の 3 段階**から選びます。
+
+**A. Public データのみ:**
+
+価格・板・ローソク足などの公開市場データの取得と分析。API キー不要。
 
 ```json
 {
@@ -83,7 +92,9 @@ Node.js のバージョンアップで設定を書き換える必要がないた
 }
 ```
 
-**Private ツールも使う場合（API キーあり）**:
+**B. Private データ参照系（要 API キー）:**
+
+資産残高・約定履歴・注文照会・ポートフォリオ分析などの読み取り専用。発注はできません。
 
 ```json
 {
@@ -100,26 +111,44 @@ Node.js のバージョンアップで設定を書き換える必要がないた
 }
 ```
 
-API キーは [bitbank 設定画面](https://app.bitbank.cc/account/api) で発行してください。**必要最小限の権限のみ付与する**ことを強く推奨します（最小権限の原則）。
+> ✅ **bitbank API の権限は「参照」のみ設定することを推奨**
 
-| やりたいこと | 必要な権限 |
-|---|---|
-| 資産確認・ポートフォリオ分析（読み取り専用） | **「参照」のみ** ← 最も安全、迷ったらこちら |
-| 上記 + AI に発注・キャンセル操作も任せたい | 「参照」+「取引」 |
+**C. 取引注文・注文キャンセル実行（要 API キー）:**
 
-⚠️ **「出金」権限は絶対に有効化しないでください**。本 MCP サーバーは出金系ツールを実装していないため、この権限を付ける必要は一切ありません。漏洩時の資産流出を避けるためです。
+B に加えて、AI からの発注・注文キャンセルまで実行。実行前に必ず確認ステップ（preview → execute の 2 段階確認）が入ります。
+
+```json
+{
+  "mcpServers": {
+    "bitbank-lab": {
+      "command": "npx",
+      "args": ["-y", "bitbank-lab-mcp"],
+      "env": {
+        "BITBANK_API_KEY": "your_api_key",
+        "BITBANK_API_SECRET": "your_api_secret",
+        "BITBANK_TRUST_HOST_APPROVAL": "1"
+      }
+    }
+  }
+}
+```
 
-**IP 制限**: bitbank 側で API キーに IP 制限を設定できる場合は、可能な限り設定を推奨します。詳細: [Private API ガイド](docs/private-api.md)。
+> ✅ **bitbank API の権限は「参照」および「取引」のみ設定することを推奨**
+>
+> ※ **「出金」権限は有効化しないことを強く推奨します**。本サーバーは出金系ツール未実装のため不要です。
 
-#### オプション環境変数
+`BITBANK_TRUST_HOST_APPROVAL`（値は文字列の `"1"` のみ有効）は、Claude Desktop の確認ボタンから発注/キャンセルを実行できるようにするオプトインです。有効化すると確認トークンが LLM からも見える経路で返るため、理論上は LLM が確認ボタンを経ずに実行を試みる余地を受け入れることになります。ただしトークンは**プレビューした注文 1 件のみ有効・期限 60 秒・使い捨て**で、実行前には毎回ホストの承認ダイアログが最終ゲートとして入るため、影響は限定的です。このゲートを保つため、**取引ツールは「常に許可（Always allow）」にせず毎回確認**してください。
 
-| 変数 | 既定 | 用途 |
-|---|---|---|
-| `BITBANK_TRUST_HOST_APPROVAL` | unset（無効） | `1` を設定すると、elicitation を advertise しないが SEP-1865 iframe をサポートするホスト（Claude Desktop / claude-ai 等）で、preview の確認 UI ボタンから注文/キャンセルを実行できるようにする妥協モード。詳細とセキュリティ前提は [ADR-0007](docs/adr/0007-hitl-confirmation-token-delivery.md) と [Private API ガイド](docs/private-api.md) を参照。**有効化時は `create_order` 等のツールを「常に許可」しないこと**。 |
+詳細: [ADR-0007](docs/adr/0007-hitl-confirmation-token-delivery.md) / [Private API ガイド](docs/private-api.md)。
+
+B / C の API キーは [bitbank 設定画面](https://app.bitbank.cc/account/api) で発行し、**必要最小限の権限のみ**を付与、可能なら **IP 制限**も設定してください（最小権限の原則）。
 
-#### 方式B：`npx` の絶対パスを指定（フォールバック）
+詳細: [Private API ガイド](docs/private-api.md)。
 
-方式A で「サーバーに接続できません」エラーが出る場合、Claude Desktop から `npx` コマンドが見つけられていない可能性があります。その場合は、`npx` の絶対パスを指定してください。
+#### 絶対パス方式（フォールバック）
+
+npx 方式で「サーバーに接続できません」エラーが出る場合、Claude Desktop から `npx` コマンドが見つけられていない可能性があります。  
+その場合は、`npx` の絶対パスを指定してください。
 
 まずターミナルで自分の環境の `npx` パスを確認します：
 
@@ -153,7 +182,7 @@ which npx
 
 #### Windows の場合
 
-Windows でも方式A の `npx` 経由がそのまま使えます：
+Windows でも npx 方式がそのまま使えます：
 
 ```json
 {
@@ -177,7 +206,7 @@ Claude Desktop の UI に表示される名前は `claude_desktop_config.json`
 ```json
 {
   "mcpServers": {
-    "ビットバンクMCP": {
+    "bitbank-lab-mcp": {
       "command": "npx",
       "args": ["-y", "bitbank-lab-mcp"]
     }
@@ -185,7 +214,7 @@ Claude Desktop の UI に表示される名前は `claude_desktop_config.json`
 }
 ```
 
-日本語名も使用可能です。
+> ⚠️ `bitbank-lab-mcp` のような ASCII（英数字）の名前を推奨します。環境によって、日本語などの非 ASCII 名だと Chat でツールが見つからない事例があります。
 
 #### 共通の注意事項
 
@@ -196,24 +225,63 @@ Claude Desktop の UI に表示される名前は `claude_desktop_config.json`
 - macOS: `~/Library/Application Support/Claude/claude_desktop_config.json`
 - Windows: `%APPDATA%\Claude\claude_desktop_config.json`
 
-### 2. Plugin として install（Claude Code / Cursor / Codex / Gemini CLI）
+### 2. その他の MCP クライアント（手動 `.json` 編集）
+
+#### Cursor（`.cursor/mcp.json`）
+
+```json
+{
+  "mcpServers": {
+    "bitbank-lab": {
+      "command": "npx",
+      "args": ["-y", "bitbank-lab-mcp"],
+      "env": {
+        "BITBANK_API_KEY": "your_api_key",
+        "BITBANK_API_SECRET": "your_api_secret"
+      }
+    }
+  }
+}
+```
 
-これらのクライアントには plugin manifest（`.claude-plugin/plugin.json` ほか 3 種）を同梱しています。各クライアントの `/plugin install`（または相当のコマンド）でこのリポジトリを指定するだけでセットアップが完了します。**API キー入力 UI を備えているのは Claude Code と Gemini CLI のみ** — Cursor / Codex はシェル環境変数で API キーを渡す方式です（後述）。
+API キーが不要な場合は `env` ブロックごと削除して OK。セクション 1 の A〜C と同様に、取引実行まで使う場合のみ `BITBANK_TRUST_HOST_APPROVAL` を検討してください。
+
+#### Claude Code（CLI から登録する場合）
+
+```bash
+claude mcp add --transport stdio bitbank-lab -- npx -y bitbank-lab-mcp
+```
+
+同梱 Skill も一緒に使いたい場合は、[セクション 3](#3-オプションplugin-として-install同梱-skill-を使う) の plugin install が便利です。
+
+#### Windsurf / その他の汎用 MCP クライアント
+
+Cursor と同じ JSON 形式で登録できます。クライアント固有の設定ファイルパスについては各クライアントのドキュメントを参照してください。
+
+### 3. （オプション）Plugin として install（同梱 Skill を使う）
+
+通常の利用はセクション 1〜2 の登録だけで完結します。Plugin install は、**Claude Code などの AI コーディングツールで、MCP サーバーに加えて同梱 Skill（`skills/` 配下）も使いたい方向け**のオプションです。
+
+- Plugin として install すると、MCP ツールと同時に同梱 Skill（例: `investment-onboarding`）が有効化されます。今後 Skill を追加した場合も、plugin のアップデートでまとめて届きます。
+- Skill を自作してワークフローをカスタマイズしたい方は、[`skills/INDEX.md`](skills/INDEX.md) の構成が参考になります。
+- **Claude Desktop は plugin / Skill の読み込みに未対応**です。Claude Desktop で使う場合は[セクション 1](#1-claude-desktop-に登録推奨) の方法で登録してください（MCP ツールの機能は同じで、Skill が使えるかどうかだけの違いです）。
 
 | クライアント | manifest | API キーの渡し方 |
 |---|---|---|
 | Claude Code | `.claude-plugin/plugin.json` | ✅ **GUI で入力**: `/plugin install` 直後に `userConfig` UI が表示され、OS キーチェーンに保管 |
-| Gemini CLI | `gemini-extension.json` | ✅ **対話 prompt**: `settings` 配列で対話的に入力、`.env` に保管 |
+| Antigravity CLI（旧 Gemini CLI） | `gemini-extension.json` | ✅ **対話 prompt**: `settings` 配列で対話的に入力、`.env` に保管 |
 | Cursor | `.cursor-plugin/plugin.json` | ⚙️ **シェル環境変数のみ**: `BITBANK_API_KEY` / `BITBANK_API_SECRET` を環境変数に設定（Cursor は plugin 経由の prompt 未対応） |
 | Codex | `.codex-plugin/plugin.json` | ⚙️ **シェル環境変数のみ**: `BITBANK_API_KEY` / `BITBANK_API_SECRET` を環境変数に設定 |
 
 > いずれの manifest も npm registry の [`bitbank-lab-mcp`](https://www.npmjs.com/package/bitbank-lab-mcp) を `npx -y` 経由で起動します。
+>
+> Gemini CLI は 2026-06-18 に個人アカウント向け提供を終了し、Antigravity CLI（`agy`）に移行しました。Antigravity CLI は旧 Gemini CLI 拡張（`gemini-extension.json`）を後方互換で読み込みます（`agy plugin import gemini` でネイティブ plugin へ変換も可能）。
 
 **Claude Code の例**:
 
 ```bash
 # 1. このリポジトリを marketplace として登録（初回のみ）
-/plugin marketplace add tjackiet/bitbank-lab-mcp
+/plugin marketplace add bitbankinc/bitbank-lab-mcp
 
 # 2. plugin を install
 /plugin install bitbank-lab-mcp@bitbank-lab
@@ -239,39 +307,6 @@ export BITBANK_API_SECRET="your_api_secret"
 
 macOS / Linux では `~/.zshrc` や `~/.bashrc` に書いておくと永続化されます。Windows は環境変数の管理画面 or `setx` を使用してください。
 
-### 3. その他の MCP クライアント（手動 `.json` 編集）
-
-#### Cursor（`.cursor/mcp.json`）
-
-```json
-{
-  "mcpServers": {
-    "bitbank-lab": {
-      "command": "npx",
-      "args": ["-y", "bitbank-lab-mcp"],
-      "env": {
-        "BITBANK_API_KEY": "your_api_key",
-        "BITBANK_API_SECRET": "your_api_secret"
-      }
-    }
-  }
-}
-```
-
-API キーが不要な場合は `env` ブロックごと削除して OK。
-
-#### Claude Code（CLI から登録する場合）
-
-[セクション 2](#2-plugin-として-installclaude-code--cursor--codex--gemini-cli) の plugin install を推奨しますが、CLI から手動登録する場合は：
-
-```bash
-claude mcp add --transport stdio bitbank-lab -- npx -y bitbank-lab-mcp
-```
-
-#### Windsurf / その他の汎用 MCP クライアント
-
-Cursor と同じ JSON 形式で登録できます。クライアント固有の設定ファイルパスについては各クライアントのドキュメントを参照してください。
-
 ### 4. 使ってみる
 AI クライアントにそのまま話しかけます:
 ```
@@ -306,7 +341,7 @@ export BITBANK_API_SECRET="your_api_secret"
 
 **Plugin install を使った場合** — `/plugin` から該当 plugin の設定を開き、`api_key` / `api_secret` を入力すれば完了です（手動編集は不要）。
 
-**Claude Desktop で手動設定している場合** — `claude_desktop_config.json` の `env` に追加（[セクション 1](#1-claude-desktop-に登録最短推奨) で設定した方式A／方式B のいずれかに、以下のように `BITBANK_API_KEY` と `BITBANK_API_SECRET` を追加するだけです）:
+**Claude Desktop で手動設定している場合** — `claude_desktop_config.json` の `env` に追加（[セクション 1](#1-claude-desktop-に登録推奨) で設定した npx 方式／絶対パス方式のいずれかに、以下のように `BITBANK_API_KEY` と `BITBANK_API_SECRET` を追加するだけです）:
 ```json
 {
   "mcpServers": {
@@ -390,25 +425,25 @@ npx @modelcontextprotocol/inspector -- npx -y bitbank-lab-mcp
 | 症状 | 原因・対処 |
 |------|-----------|
 | Claude Desktop にツールが表示されない | `claude_desktop_config.json` の JSON 構文が壊れている / Claude Desktop を `Cmd+Q`（Windows は完全終了）で再起動していない |
-| 「サーバーに接続できません」エラー（npx 方式） | Claude Desktop から `npx` が見つからない可能性。[方式B（npx 絶対パス）](#方式bnpx-の絶対パスを指定フォールバック)に切り替える |
+| 「サーバーに接続できません」エラー（npx 方式） | Claude Desktop から `npx` が見つからない可能性。[絶対パス方式](#絶対パス方式フォールバック)に切り替える |
 | `spawn npx ENOENT` エラー | `which npx` の結果が異なるパスを指している。`command` を正しいパスに書き換える |
-| Node.js アップデート後に MCP が動かなくなった | nvm/volta の場合、Node.js バージョンが変わると絶対パスも変わる。`which npx` を再確認して `command` を更新するか、方式A（`npx` 名指し）に切り替える |
+| Node.js アップデート後に MCP が動かなくなった | nvm/volta の場合、Node.js バージョンが変わると絶対パスも変わる。`which npx` を再確認して `command` を更新するか、npx 方式（`npx` 名指し）に切り替える |
 | `Cannot find package 'tsx'` エラー | `bitbank-lab-mcp` の古い版（v0.1.0）でこの問題が発生。`npx -y bitbank-lab-mcp@latest` で最新版に更新するか、設定を再起動 |
 | ツール実行時にタイムアウト | ネットワーク接続を確認 / [bitbank API の状態](https://status.bitbank.cc/)を確認 |
 | Private API ツールが表示されない | `BITBANK_API_KEY` と `BITBANK_API_SECRET` の両方が設定されているか確認（→ [docs/private-api.md](docs/private-api.md)） |
 | ログを確認したい | `env` に `"LOG_LEVEL": "debug"` を追加して再起動 |
-| Plugin install で「Marketplace not found」 | `/plugin marketplace add tjackiet/bitbank-lab-mcp` を先に実行してから `/plugin install bitbank-lab-mcp@bitbank-lab` |
+| Plugin install で「Marketplace not found」 | `/plugin marketplace add bitbankinc/bitbank-lab-mcp` を先に実行してから `/plugin install bitbank-lab-mcp@bitbank-lab` |
 
 ---
 
 ## 開発者向け（ソースから起動）
 
-このセクションは「自分で MCP サーバーをいじりたい」「PR を送りたい」という開発者向けです。**通常の利用者は[セクション 1](#1-claude-desktop-に登録最短推奨) の `npx -y bitbank-lab-mcp` 方式で OK** です（こちらは clone 不要）。
+このセクションは「自分で MCP サーバーをいじりたい」「PR を送りたい」という開発者向けです。**通常の利用者は[セクション 1](#1-claude-desktop-に登録推奨) の `npx -y bitbank-lab-mcp` 方式で OK** です（こちらは clone 不要）。
 
 ### セットアップ
 
 ```bash
-git clone https://github.com/tjackiet/bitbank-lab-mcp.git
+git clone https://github.com/bitbankinc/bitbank-lab-mcp.git
 cd bitbank-lab-mcp
 npm ci
 ```
@@ -467,7 +502,7 @@ npx @modelcontextprotocol/inspector -- tsx src/server.ts
 
 ## フィードバック・バグ報告
 
-バグ報告や機能要望は [GitHub Issues](https://github.com/tjackiet/bitbank-lab-mcp/issues) からお願いします。Issue テンプレートを用意していますので、用途に合ったものを選択してください。
+バグ報告や機能要望は [GitHub Issues](https://github.com/bitbankinc/bitbank-lab-mcp/issues) からお願いします。Issue テンプレートを用意していますので、用途に合ったものを選択してください。
 
 ## 免責事項
 
@@ -503,4 +538,4 @@ npx @modelcontextprotocol/inspector -- tsx src/server.ts
 
 APIキーおよび取引に必要なパスワード等は利用者自身の責任において適切に管理してください。チャット欄や公開リポジトリその他第三者が閲覧可能な環境等へ APIキーや取引パスワード等の認証情報等を入力・掲載しないよう十分ご注意ください。
 
-利用者による認証情報等の管理不備、誤入力、漏えい、第三者利用等により生じたいかなる損害についても、当社の故意または重過失による場合を除き、当社は一切責任を負いません。
+利用者による認証情報等の管理不備、誤入力、漏えい、第三者利用等により生じたいかなる損害についても、当社の故意または重過失による場合を除き、当社は一切責任を負いません。