# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Thehiveryiq Com Tradeguard API
  version: 1.0.0
extends: openapi/thehiveryiq-com-tradeguard-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 11
- target: $.paths['/v1/tradeguard/mcp'].get
  update:
    x-apievangelist-phrasing:
      intent: Describe the TradeGuard MCP server
      effect: read
      questions:
      - Does TradeGuard expose an MCP server, and what does it describe?
      - Where is the metadata for the TradeGuard MCP endpoint?
      instructions:
      - text: Show me the TradeGuard MCP server metadata.
      - text: Describe the TradeGuard MCP endpoint.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/tradeguard/mcp'].post
  update:
    x-apievangelist-phrasing:
      intent: Call the TradeGuard MCP server
      effect: write
      questions:
      - Can I send MCP JSON-RPC requests to TradeGuard from my agent?
      - Where do MCP tool calls for TradeGuard get posted?
      instructions:
      - text: Send this MCP request to TradeGuard.
      - text: Call a TradeGuard tool over MCP.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/tradeguard/health'].get
  update:
    x-apievangelist-phrasing:
      intent: Check TradeGuard health
      effect: read
      questions:
      - Is the TradeGuard trade attestation service healthy?
      - Can I check whether TradeGuard is up before attesting orders?
      instructions:
      - text: Check TradeGuard health.
      - text: Tell me if TradeGuard is up.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/tradeguard/pricing'].get
  update:
    x-apievangelist-phrasing:
      intent: Get TradeGuard pricing
      effect: read
      questions:
      - What does TradeGuard charge to attest a trade?
      - Which pricing tiers does TradeGuard offer?
      instructions:
      - text: Show me TradeGuard pricing.
      - text: Get the cost of trade attestations.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/tradeguard/attest'].post
  update:
    x-apievangelist-phrasing:
      intent: Attest an order event for audit
      effect: write
      questions:
      - How do I create a signed attestation for an algorithmic order event?
      - Can an attestation record symbol, side, quantity and price for a trade?
      instructions:
      - text: Attest order event {order_event_hash} for trader {trader_did} at firm {firm_did}, algo {algo_id}, type {event_type} on {venue}.
        slots:
          order_event_hash: requestBody.order_event_hash
          trader_did: requestBody.trader_did
          firm_did: requestBody.firm_did
          algo_id: requestBody.algo_id
          event_type: requestBody.event_type
          venue: requestBody.venue
      - text: Record a {side} of {quantity} {symbol} from algo {algo_id} as an attestation.
        slots:
          side: requestBody.side
          quantity: requestBody.quantity
          symbol: requestBody.symbol
          algo_id: requestBody.algo_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/tradeguard/verify/{attestation_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Verify a trade attestation
      effect: read
      questions:
      - Can I confirm a TradeGuard attestation is valid given its ID?
      - What does verifying a trade attestation return?
      instructions:
      - text: Verify attestation {attestation_id}.
        slots:
          attestation_id: path.attestation_id
      - text: Check that trade attestation {attestation_id} is authentic.
        slots:
          attestation_id: path.attestation_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/tradeguard/by-event-hash/{order_event_hash}'].get
  update:
    x-apievangelist-phrasing:
      intent: Find an attestation by order event hash
      effect: read
      questions:
      - Which attestation covers a particular order event hash?
      - Can I look up a trade attestation from the order event's hash?
      instructions:
      - text: Find the attestation for order event hash {order_event_hash}.
        slots:
          order_event_hash: path.order_event_hash
      - text: Look up event hash {order_event_hash} in TradeGuard.
        slots:
          order_event_hash: path.order_event_hash
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/tradeguard/by-trader/{trader_did}'].get
  update:
    x-apievangelist-phrasing:
      intent: List attestations for a trader
      effect: read
      questions:
      - What trades has a given trader had attested?
      - Can I page through one trader's attestations?
      instructions:
      - text: List attestations for trader {trader_did}.
        slots:
          trader_did: path.trader_did
      - text: Show {limit} attestations for trader {trader_did} starting at {offset}.
        slots:
          trader_did: path.trader_did
          limit: query.limit
          offset: query.offset
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/tradeguard/by-firm/{firm_did}'].get
  update:
    x-apievangelist-phrasing:
      intent: List attestations for a firm
      effect: read
      questions:
      - Which attestations has a trading firm recorded across all its traders?
      - Can I paginate a firm's trade attestations?
      instructions:
      - text: List attestations for firm {firm_did}.
        slots:
          firm_did: path.firm_did
      - text: Show the next {limit} attestations for firm {firm_did} from offset {offset}.
        slots:
          firm_did: path.firm_did
          limit: query.limit
          offset: query.offset
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/tradeguard/by-algo/{firm_did}/{algo_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: List attestations for one trading algorithm
      effect: read
      questions:
      - What orders has a specific algorithm at a firm had attested?
      - Can I audit a single trading algo's attestation history?
      instructions:
      - text: List attestations for algo {algo_id} at firm {firm_did}.
        slots:
          algo_id: path.algo_id
          firm_did: path.firm_did
      - text: Show {limit} attestations for firm {firm_did}'s algorithm {algo_id}.
        slots:
          limit: query.limit
          firm_did: path.firm_did
          algo_id: path.algo_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/tradeguard/leaderboard'].get
  update:
    x-apievangelist-phrasing:
      intent: View the TradeGuard leaderboard
      effect: read
      questions:
      - Who is attesting the most trades on TradeGuard lately?
      - Can I see the leaderboard over a custom number of days?
      instructions:
      - text: Show the TradeGuard leaderboard.
      - text: Show the top {limit} on the leaderboard for the last {days} days.
        slots:
          limit: query.limit
          days: query.days
      method: generated
      generated: '2026-09-26'