Skip to main content

Tools

@okooo/bb-api-mcp が提供する MCP ツールの一覧です。AI アシスタントから呼び出すことで SDK のソースコードを参照・検索できます。

list_sdk_files​

SDK の src ディレクトリ以下にある全 TypeScript ファイルのパス一覧を返します。

入力パラメータ: なし

出力例:

constants/enum.ts
index.ts
private-stream-client.ts
public-rest-client.ts
public-stream-client.ts
rest-client.ts
types/index.ts
types/request/deposit.ts
types/request/order.ts
...

使用例（Claude へのプロンプト）:

"bb-api SDK にどんなファイルがある？"

get_sdk_file​

指定したファイルのソースコードを全文返します。

入力パラメータ:

パラメータ型必須説明
pathstringYesSDK src ルートからの相対パス（例: "rest-client.ts", "types/shared.ts"）

出力: 指定ファイルの TypeScript ソースコード全文

使用例（Claude へのプロンプト）:

"rest-client.ts の内容を見せて" "types/request/order.ts を確認して"

search_sdk​

SDK 全ソースファイルをキーワードで横断検索します。マッチした行をファイル名・行番号付きで返します（大文字小文字を区別しません）。

入力パラメータ:

パラメータ型必須説明
querystringYes検索キーワード（大文字小文字を区別しない）

出力例（query: "submitOrder"）:

rest-client.ts:69:   submitOrder(params: SubmitOrderRequest): Promise<BitbankApiResponse<OrderResponse>> {
types/request/order.ts:3: export interface SubmitOrderRequest {

使用例（Claude へのプロンプト）:

"SDK で cancelOrder が定義されている場所を探して" "PairString 型はどこで定義されている？"

get_api_overview​

SDK の全クライアントクラスと公開メソッドを構造化したサマリーテキストを返します。

入力パラメータ: なし

出力例:

# bitbank-api SDK Overview

## RestClient (rest-client.ts)

  getAssets()
  getOrder(params: GetOrderRequest)
  submitOrder(params: SubmitOrderRequest)
  cancelOrder(params: CancelOrderRequest)
  ...

## PublicRestClient (public-rest-client.ts)

  getTicker(pair: PairString)
  getDepth(pair: PairString)
  ...

使用例（Claude へのプロンプト）:

"bb-api SDK でどんなメソッドが使える？" "注文関連のメソッドを一覧で教えて"