Skip to main content
Glama
bybit-exchange

Bybit MCP Server

Official
by bybit-exchange
OverviewSchemaSourceRelated ServersScoreDiscussionsAdmin
TypeScript
Remote

getFGridDetail

Read-only

Retrieve full details of a futures grid bot, including configuration, status, PnL metrics, position, and margin balances, to monitor performance and diagnose stopped bots.

Instructions

Retrieves comprehensive details for a specific futures grid bot, including configuration (symbol, price range, leverage, grid type), current status, PnL metrics (realized, unrealized, grid profit, funding fee), position info, margin balances, and timestamps.

The bot_id is a numeric ID obtained from createFGridBot or bot listing endpoints.

Rate limit: 10 requests per second per UID.

Agent hint: Use this endpoint to check the status and performance of a grid bot. The response contains all PnL fields, position details, and close reason if the bot has stopped. Prefer this over other endpoints when answering questions about a specific bot's performance.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
bot_idYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv2.1.20
    • addedInput schema / properties / bot_id / anyOf
      Added value: +[
+  {
+    "pattern": "^[0-9]+$",
+    "type": "string"
+  },
+  {
+    "maximum": 9007199254740991,
+    "minimum": -9007199254740991,
+    "type": "integer"
+  }
+]
    • removedInput schema / properties / bot_id / type
      Removed value: -"integer"
  2. First observedv2.1.11

TDQS

A4.7/5.0
Behavior5/5

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

Annotations mark the tool read-only, and the description adds meaningful behavioral detail: rate limit of 10 requests per second per UID, response includes all PnL fields, position details, and close reason if the bot has stopped. This goes beyond the structured metadata and helps set expectations.

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?

Every sentence contributes value: scope, parameter source, rate limit, and an actionable agent hint. There is no filler or redundant restatement of the tool name.

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

Completeness5/5

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

For a simple one-parameter, read-only detail endpoint, the description is complete: it covers what data is returned, when to use it, how to obtain the parameter, and the rate limit. The absence of an output schema is mitigated by the enumerated response categories.

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

Parameters4/5

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

With 0% schema description coverage, the description compensates by explaining that bot_id is a numeric ID obtained from createFGridBot or bot listing endpoints. This adds provenance information beyond the schema's type constraints, though it does not elaborate much further.

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

Purpose5/5

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

The description begins with a precise verb-resource pair: 'Retrieves comprehensive details for a specific futures grid bot' and lists the covered categories (configuration, status, PnL, position, margin, timestamps). This clearly distinguishes it from sibling endpoints like getFMartDetail, getComboDetail, and createFGridBot/closeFGridBot.

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?

The 'Agent hint' explicitly instructs agents to use the endpoint for checking status and performance, and says to prefer it over other endpoints when answering questions about a specific bot's performance. It does not name exact alternative endpoints, but the usage context is clear.

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

Install Server

Other Tools