Skip to main content
Glama
bybit-exchange

Bybit MCP Server

Official

startSubscription

Start a durable Bybit WebSocket subscription that buffers topic messages and returns a subscription ID for later retrieval or cancellation. Subscriptions close automatically after five minutes without reads.

Instructions

开启一个持久 WebSocket 订阅,后台持续积累消息。 返回 subscriptionId,用于后续 readMessages / stopSubscription 调用。 订阅在 5 分钟内未被 readMessages 访问时自动关闭。 同一 topic 可同时存在多个独立订阅。

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
topicYes完整 topic 字符串,如 "orderbook.50.BTCUSDT" 或 "execution.linear"
categoryYesWS 端点分类
maxMessagesNo单个订阅的消息缓冲上限,超出时丢弃最旧的消息(默认 500)
requiresAuthNo私有频道(execution、order、position、wallet 等)设为 true

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv2.1.11

TDQS

A4.2/5.0
Behavior5/5

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

The description goes well beyond the annotations (readOnlyHint=false, openWorldHint=true, destructiveHint=false) by disclosing specific behavioral traits: background message accumulation, auto-close after 5 minutes without readMessages access, and support for multiple independent subscriptions on the same topic. These details are not present in the annotations or schema and are critical for correct usage.

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?

The description is compact and information-dense, with each of the four sentences contributing a distinct, necessary fact: what the tool does, what it returns, the timeout behavior, and concurrency semantics. There is no redundant or filler content, and the most important functional statement is front-loaded.

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?

For a subscription-starting tool with no output schema, the description adequately covers the return value (subscriptionId) and the required follow-up calls (readMessages/stopSubscription). The 5-minute timeout and per-topic multiplicity are also covered. Minor gaps include the lack of explicit limits on the number of concurrent subscriptions and any mention of authentication requirements, though the latter is partially addressed by the requiresAuth parameter description.

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 input schema already provides 100% parameter coverage with descriptions for topic, category, maxMessages, and requiresAuth. The description adds no parameter-specific meaning beyond what the schema provides, so the baseline of 3 applies. It does not clarify formats or defaults beyond schema, but the schema is already descriptive.

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 states a specific action ('开启' - start) applied to a distinct resource: a persistent WebSocket subscription that accumulates messages in the background. It clearly differentiates from the many sibling subscribe* tools by emphasizing the persisted buffer and the returned subscriptionId, which is central to the tool's purpose.

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

Usage Guidelines3/5

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

The description provides a clear workflow: start the subscription, then use readMessages and stopSubscription with the returned subscriptionId. It also highlights the 5-minute inactivity timeout, which is essential usage guidance. However, it does not explicitly state when to choose this over the sibling subscribe* streaming tools, so the agent must infer that this is for buffered/queued retrieval rather than real-time streaming.

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