Skip to main content
Glama
bybit-exchange

Bybit MCP Server

Official

getTaxReportUrl

Destructive

Get the download URL of a completed tax report file.

Instructions

Get the download URL of a completed tax report file.

Prerequisite: Confirm file status is 2 (generated) via the Status endpoint first.

Response notes: The url field returns a JSON string containing the file list and base path, formatted as {"Files":["file1.csv","file2.csv"],"Basepath":"https://..."}.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
queryIdYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv2.1.24

TDQS

A3.8/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare openWorldHint=true, readOnlyHint=false and destructiveHint=true, so the safety profile is covered structurally. The description adds a real prerequisite and the unusual return shape of the `url` field (a JSON string with Files/Basepath), which is useful. However, it never addresses why a 'Get' operation carries destructiveHint=true, leaving the agent with an unexplained mismatch rather than a disclosed behavior.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Three short blocks with bolded labels ('Prerequisite', 'Response notes') and the core action front-loaded in the first sentence. Every sentence carries information the agent needs; there is no filler.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

With no output schema, the description responsibly documents the shape of the returned `url` value, and it supplies the sequencing prerequisite. It is close to complete for a one-parameter call, though it omits anything about authentication/scope or what the caller should do with the URL once obtained.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The single required parameter `queryId` has 0% schema description coverage and the description never explains what it is or where it comes from, only implying it identifies the tax report. The agent must infer the value from the report-creation flow. The description therefore does not compensate for the schema gap.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description gives a specific verb+resource: retrieving the download URL for a completed tax report file. It implicitly separates itself from the status-checking sibling by naming the 'Status endpoint' as a prerequisite step. It stops short of explicitly contrasting with getTaxReportStatus or the batch variants, so it is clear but not fully differentiated.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

It states a concrete precondition ('Confirm file status is `2` (generated) via the Status endpoint first'), which tells the agent when this call is valid and routes it to the sibling that must be called first. There is no explicit 'do not call this if...' guidance, but the ordering constraint is unambiguous.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

Other Tools