Zaifer-MCP

Instructions

    指定した通貨ペアの板情報を取得します。

    市場全体の売買注文状況を表示し、あなた個人の注文一覧（get_open_orders）とは異なります。
    全市場参加者の注文が価格順に並んだ情報で、以下の用途で使用します：
    - 市場の流動性と売買圧力を分析したい場合
    - 大量注文前に市場の深さを確認したい場合
    - サポート・レジスタンスレベルを特定したい場合

    使用例:
    - 大きな注文を出す前に市場の流動性を確認したい場合
    - 現在のビッド・アスクスプレッドを詳細に分析したい場合
    - 特定価格帯での注文量を確認したい場合

    Args:
        currency_pair: 通貨ペア（'btc_jpy': ビットコイン/円、'eth_jpy': イーサリアム/円、'xym_jpy': シンボル/円）

    Returns:
        OrderBook: 市場全体の板情報
            - asks: 売り注文一覧（price・quantity）
            - bids: 買い注文一覧（price・quantity）

    Raises:
        ValueError: 通貨ペアが無効な場合や、APIエラーが発生した場合
    

Implementation Reference

• zaifer_mcp/tools/market.py:53-80 (handler)

  The handler function for the 'get_market_depth' tool. It takes a SupportedPair as input and returns an OrderBook by calling the ZaifApi market depth method.

  @mcp.tool()
  def get_market_depth(currency_pair: SupportedPair) -> OrderBook:
      """
      指定した通貨ペアの板情報を取得します。
  
      市場全体の売買注文状況を表示し、あなた個人の注文一覧（get_open_orders）とは異なります。
      全市場参加者の注文が価格順に並んだ情報で、以下の用途で使用します：
      - 市場の流動性と売買圧力を分析したい場合
      - 大量注文前に市場の深さを確認したい場合
      - サポート・レジスタンスレベルを特定したい場合
  
      使用例:
      - 大きな注文を出す前に市場の流動性を確認したい場合
      - 現在のビッド・アスクスプレッドを詳細に分析したい場合
      - 特定価格帯での注文量を確認したい場合
  
      Args:
          currency_pair: 通貨ペア（'btc_jpy': ビットコイン/円、'eth_jpy': イーサリアム/円、'xym_jpy': シンボル/円）
  
      Returns:
          OrderBook: 市場全体の板情報
              - asks: 売り注文一覧（price・quantity）
              - bids: 買い注文一覧（price・quantity）
  
      Raises:
          ValueError: 通貨ペアが無効な場合や、APIエラーが発生した場合
      """
      return api.market.get_depth(currency_pair)

• zaifer_mcp/server.py:34-42 (registration)

  Registration of market tools (including get_market_depth) via register_market_tools call in the main server setup.

  from zaifer_mcp.tools.market import register_market_tools
  from zaifer_mcp.tools.account import register_account_tools
  from zaifer_mcp.tools.trade import register_trade_tools
  from zaifer_mcp.tools.chart import register_chart_tools
  
  register_market_tools(mcp, zaif_api)
  register_account_tools(mcp, zaif_api)
  register_trade_tools(mcp, zaif_api)
  register_chart_tools(mcp, zaif_api)

• zaifer_mcp/models/common.py:7-7 (schema)

  Input schema: SupportedPair type, restricting currency pairs to supported ones.

  SupportedPair = Literal["btc_jpy", "eth_jpy", "xym_jpy"]

• zaifer_mcp/models/market.py:225-263 (schema)

  Output schema: OrderBook dataclass defining the structure of market depth data with asks and bids lists.

  class OrderBook:
      """
      板情報を表すデータクラス。
      
      Attributes:
          asks: 売り注文リスト
          bids: 買い注文リスト
      """
      asks: List[OrderBookItem]
      bids: List[OrderBookItem]
      
      @classmethod
      def from_dict(cls, data: Dict[str, Any]) -> 'OrderBook':
          """
          APIレスポンスからOrderBookインスタンスを作成します。
          
          Args:
              data: APIレスポンスの辞書
              
          Returns:
              OrderBookインスタンス
          """
          asks = [OrderBookItem(Decimal(str(item[0])), Decimal(str(item[1]))) 
                  for item in data.get('asks', [])]
          bids = [OrderBookItem(Decimal(str(item[0])), Decimal(str(item[1]))) 
                  for item in data.get('bids', [])]
          return cls(asks=asks, bids=bids)
      
      def to_dict(self) -> Dict[str, Any]:
          """
          OrderBookインスタンスをAPIレスポンス形式の辞書に変換します。
          
          Returns:
              APIレスポンス形式の辞書
          """
          return {
              'asks': [[str(item.price), str(item.quantity)] for item in self.asks],
              'bids': [[str(item.price), str(item.quantity)] for item in self.bids]
          }

• zaifer_mcp/tools/market.py:12-12 (registration)

  The register_market_tools function where the @mcp.tool() decorator for get_market_depth is applied.

  def register_market_tools(mcp: FastMCP, api: ZaifApi):