Zaifer-MCP

Instructions

    アカウントの残高情報を取得します。
    
    このツールは、取引前の残高確認や投資可能額の算出に使用します。
    すべての通貨の残高を一度に取得し、利用可能な資金を確認できます。
    
    使用例:
    - 取引前に利用可能な資金を確認したい場合
    - ポートフォリオの総資産価値を計算したい場合
    - 各通貨の保有量を確認したい場合
    - 投資可能額を把握したい場合
    
    注意: このツールを使用するには、環境変数にAPIキーとシークレットが設定されている必要があります。
    
    Returns:
        AccountBalance: アカウント残高情報
            - balances: 各通貨の残高情報（通貨コードをキーとする辞書）
            - permissions: 利用権限情報（APIの各機能に対する権限を示す辞書）
    
    Raises:
        ValueError: 認証情報が設定されていない場合や、APIエラーが発生した場合
    

Implementation Reference

• zaifer_mcp/tools/account.py:19-48 (handler)

  The core handler function for the 'get_account_balance' tool, decorated with @mcp.tool(). It checks authentication and calls the Zaif API to retrieve account balance information, returning an AccountBalance object.

  @mcp.tool()
  def get_account_balance() -> AccountBalance:
      """
      アカウントの残高情報を取得します。
      
      このツールは、取引前の残高確認や投資可能額の算出に使用します。
      すべての通貨の残高を一度に取得し、利用可能な資金を確認できます。
      
      使用例:
      - 取引前に利用可能な資金を確認したい場合
      - ポートフォリオの総資産価値を計算したい場合
      - 各通貨の保有量を確認したい場合
      - 投資可能額を把握したい場合
      
      注意: このツールを使用するには、環境変数にAPIキーとシークレットが設定されている必要があります。
      
      Returns:
          AccountBalance: アカウント残高情報
              - balances: 各通貨の残高情報（通貨コードをキーとする辞書）
              - permissions: 利用権限情報（APIの各機能に対する権限を示す辞書）
      
      Raises:
          ValueError: 認証情報が設定されていない場合や、APIエラーが発生した場合
      """
      if not api.account.http.auth_provider:
          raise ValueError("認証情報が設定されていません。APIキーとシークレットを.envファイルに設定してください。")
      
      # 全通貨の残高を取得
      return api.account.get_info()

• zaifer_mcp/models/account.py:52-91 (schema)

  The AccountBalance dataclass schema defining the input/output structure for account balance data, used as the return type of the tool handler. Includes from_dict and to_dict for serialization.

  @dataclass
  class AccountBalance:
      """
      アカウント残高情報を表すデータクラス。
      get_info, get_info2の戻り値に対応します。
      
      Attributes:
          balances: 各通貨の残高情報
          permissions: 利用権限（get_infoのみ）
      """
      balances: Dict[str, Decimal]
      permissions: Optional[Dict[str, bool]] = None
      
      @classmethod
      def from_dict(cls, data: Dict[str, Any]) -> 'AccountBalance':
          """
          APIレスポンスからAccountBalanceインスタンスを作成します。
          
          Args:
              data: APIレスポンスの辞書
              
          Returns:
              AccountBalanceインスタンス
          """
          balances = {k: Decimal(str(v)) for k, v in data.get('funds', {}).items()}
          permissions = data.get('rights')
          return cls(balances=balances, permissions=permissions)
      
      def to_dict(self) -> Dict[str, Any]:
          """
          AccountBalanceインスタンスを辞書に変換します。
          
          Returns:
              APIレスポンス形式の辞書
          """
          result = {'funds': {k: str(v) for k, v in self.balances.items()}}
          if self.permissions is not None:
              result['rights'] = self.permissions
          return result

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

  Registration call within register_all_components function that invokes register_account_tools to add the get_account_balance tool to the FastMCP server instance. Includes the import.

  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/tools/account.py:11-48 (registration)

  The register_account_tools function that defines and registers the get_account_balance tool using the @mcp.tool() decorator on the MCP server.

  def register_account_tools(mcp: FastMCP, api: ZaifApi):
      """
      Zaifのアカウント情報APIをMCPツールとして登録する
      
      Args:
          mcp: FastMCPインスタンス
          api: ZaifApiインスタンス
      """
      @mcp.tool()
      def get_account_balance() -> AccountBalance:
          """
          アカウントの残高情報を取得します。
          
          このツールは、取引前の残高確認や投資可能額の算出に使用します。
          すべての通貨の残高を一度に取得し、利用可能な資金を確認できます。
          
          使用例:
          - 取引前に利用可能な資金を確認したい場合
          - ポートフォリオの総資産価値を計算したい場合
          - 各通貨の保有量を確認したい場合
          - 投資可能額を把握したい場合
          
          注意: このツールを使用するには、環境変数にAPIキーとシークレットが設定されている必要があります。
          
          Returns:
              AccountBalance: アカウント残高情報
                  - balances: 各通貨の残高情報（通貨コードをキーとする辞書）
                  - permissions: 利用権限情報（APIの各機能に対する権限を示す辞書）
          
          Raises:
              ValueError: 認証情報が設定されていない場合や、APIエラーが発生した場合
          """
          if not api.account.http.auth_provider:
              raise ValueError("認証情報が設定されていません。APIキーとシークレットを.envファイルに設定してください。")
          
          # 全通貨の残高を取得
          return api.account.get_info()