Skip to main content
Glama
vechain

VeChain MCP Server

Official
by vechain

B3TR: Users leaderboard

getB3TRUsersLeaderboard
Read-onlyIdempotent

Retrieve a leaderboard of users based on B3TR actions, filterable by round or date, sortable by reward amount or actions rewarded.

Instructions

Get leaderboard of users' B3TR actions via /api/v1/b3tr/actions/leaderboards/users. Optionally filter by roundId OR date (yyyy-MM-dd UTC) but not both — they are mutually exclusive. Sort by totalRewardAmount or actionsRewarded; supports cursor pagination.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
dateNoOptional date (UTC) to filter by, format yyyy-MM-dd. Mutually exclusive with roundId.
sizeNoThe results page size
cursorNoPagination cursor returned by a previous request
sortByNoSort by totalRewardAmount or actionsRewarded
roundIdNoOptional round id to filter by. Mutually exclusive with date.
directionNoThe sort direction

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
okYes
dataNoList response for users leaderboard
errorNo
networkYes
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint, etc. The description adds behavioral details beyond annotations: mutual exclusivity of filters, date format (UTC), and pagination with cursor, which are not captured by annotations alone.

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?

Two sentences, front-loaded with endpoint and purpose, then concise details on filtering, sorting, and pagination. No unnecessary words; every sentence adds value.

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?

With zero required parameters, an output schema, and 100% schema coverage, the description covers all user needs: filtering constraints, sorting, pagination. It is complete for the tool's complexity.

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?

Schema description coverage is 100%, but the description adds operational semantics: mutual exclusivity between roundId and date, date format specification, and the meaning of sortBy values. This enhances parameter understanding beyond schema.

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 explicitly states 'Get leaderboard of users' B3TR actions' with the API endpoint, making the verb and resource clear. It distinguishes from sibling tools like getB3TRAppsLeaderboard by specifying 'users' leaderboard.

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 description clearly explains the mutual exclusivity of roundId and date parameters, sorting options (totalRewardAmount or actionsRewarded), and pagination support. It provides specific usage guidance but does not explicitly contrast with alternative tools.

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

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/vechain/vechain-mcp-server'

If you have feedback or need assistance with the MCP directory API, please join our Discord server