Bybit MCP Server

Official

Overview Schema Source Related Servers Discussions Admin

getReferralUserInvitations

Read-only

Query invitation records for the authenticated Bybit referral user, with optional filters for invitee IDs, time range, page, and friend status to review referral activity.

Instructions

Query invitation records for the authenticated referral user. Optionally filter by invitee IDs, time range, page, and friend status. Use YYYY-MM-DD HH:mm:ss for startTime and endTime; MCP rejects malformed or invalid calendar dates. Page must be a uint32 and pageSize must be 0–200. Page 0 becomes 1 and pageSize 0 becomes 10. Legacy snake_case inputs are local compatibility aliases; do not supply an alias and its camelCase counterpart together. Requests and responses use camelCase. Prefer userIdMask for display; userId is the unencrypted decimal invitee ID string. Honor notShowCommission when displaying commission information. totalBaseRewards is currently unpopulated (empty string), not evidence of zero earned rewards. Actual gateway int64/enum serialization requires authenticated verification.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "getReferralUserInvitations"
  }
}

Input Schema

Name	Required	Description
`page`	No
`endTime`	No
`end_time`	No	Deprecated local alias of endTime
`pageSize`	No
`page_size`	No	Deprecated local alias of pageSize
`startTime`	No
`start_time`	No	Deprecated local alias of startTime
`userIdList`	No
`friendStatus`	No
`user_id_list`	No	Deprecated local alias of userIdList
`friend_status`	No	Deprecated local alias of friendStatus

Schema Changelog

Changes observed during successful MCP inspections.

Changed12 schema fields changedv2.1.26Nov 4, 2026

addedInput schema / properties / endTime

Added value: +{
+  "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}:[0-9]{2}$",
+  "type": "string"
+}

addedInput schema / properties / end_time / description
```
Added value: +"Deprecated local alias of endTime"
```

addedInput schema / properties / friendStatus

Added value: +{
+  "anyOf": [
+    {
+      "enum": [
+        0
+      ],
+      "type": "number"
+    },
+    {
+      "enum": [
+        1
+      ],
+      "type": "number"
+    },
+    {
+      "enum": [
+        2
+      ],
+      "type": "number"
+    },
+    {
+      "enum": [
+        3
+      ],
+      "type": "number"
+    },
+    {
+      "enum": [
+        4
+      ],
+      "type": "number"
+    },
+    {
+      "enum": [
+        5
+      ],
+      "type": "number"
+    },
+    {
+      "enum": [
+        6
+      ],
+      "type": "number"
+    },
+    {
+      "enum": [
+        7
+      ],
+      "type": "number"
+    },
+    {
+      "enum": [
+        8
+      ],
+      "type": "number"
+    },
+    {
+      "enum": [
+        9
+      ],
+      "type": "number"
+    },
+    {
+      "enum": [
+        10
+      ],
+      "type": "number"
+    }
+  ]
+}

addedInput schema / properties / friend_status / description
```
Added value: +"Deprecated local alias of friendStatus"
```

addedInput schema / properties / pageSize

Added value: +{
+  "default": 10,
+  "maximum": 200,
+  "minimum": 0,
+  "type": "integer"
+}

removedInput schema / properties / page_size / default
```
Removed value: -10
```
addedInput schema / properties / page_size / description
```
Added value: +"Deprecated local alias of pageSize"
```

addedInput schema / properties / startTime

Added value: +{
+  "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}:[0-9]{2}$",
+  "type": "string"
+}

addedInput schema / properties / start_time / description
```
Added value: +"Deprecated local alias of startTime"
```

addedInput schema / properties / userIdList

Added value: +{
+  "default": [],
+  "items": {
+    "maximum": 9007199254740991,
+    "minimum": -9007199254740991,
+    "type": "integer"
+  },
+  "type": "array"
+}

removedInput schema / properties / user_id_list / default
```
Removed value: -[]
```
addedInput schema / properties / user_id_list / description
```
Added value: +"Deprecated local alias of userIdList"
```

Addedv2.1.25Oct 21, 2026

TDQS

A3.7/5.0

Behavior5/5

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

Annotations already mark this as readOnly and openWorld, but the description adds substantial operational context: malformed date rejection, page/pageSize coercion defaults, alias conflict rules, camelCase serialization, userIdMask versus userId display guidance, notShowCommission handling, and the caveat that totalBaseRewards is unpopulated. These are meaningful behavioral details beyond the structured annotations.

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

Conciseness4/5

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

The description is dense but front-loaded: purpose first, then filters, then constraints and data caveats. Some sentences are long and pack multiple rules together, but nearly every clause carries operational value.

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 read-only query tool with 11 parameters and no output schema, the description covers validation, pagination behavior, aliases, and field display quirks well. The main gap is the unexplained friendStatus enum mapping, which matters for filtering but does not make the definition unusable.

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?

Schema description coverage is only 45%, so the description must compensate, and it does explain the startTime/endTime format, page/pageSize bounds and defaults, alias conflicts, and userIdMask versus userId. However, it leaves friendStatus enum values (0–10) and the precise semantics of userIdList unexplained, so it only partially closes 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 states a specific verb and resource: 'Query invitation records for the authenticated referral user.' That is clear enough to identify the operation. It does not, however, distinguish this tool from nearby referral siblings such as getReferralCommissionRecords, getReferralCampaignRewards, or queryReferrals.

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

Usage Guidelines2/5

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

The description gives no explicit when-to-use or when-not-to-use guidance relative to the many sibling referral tools. It implies the tool is for the authenticated referral user's invitation records, but an agent still has to infer when this is the right choice over getReferralCommissionRecords or queryReferrals.

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

Deploy Server