List users
vital_list_usersList all Vital users in your team, paginated. Vital API: GET /v2/user.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Max users to return. | |
| offset | No | Pagination offset. |
vital_list_usersList all Vital users in your team, paginated. Vital API: GET /v2/user.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Max users to return. | |
| offset | No | Pagination offset. |
Changes observed during successful MCP inspections.
Input schema / $schemaPrevious value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The readOnlyHint annotation already declares this is a safe read, so the description's burden is lighter. It usefully adds that results are paginated and maps to GET /v2/user, but discloses nothing about auth scope, rate limits, or ordering.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two short sentences, zero padding, and the core purpose is front-loaded before the endpoint reference. Every sentence earns its place.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a read-only list tool with fully documented parameters and no output schema, this covers what an agent needs: what is listed, the scope (your team), and that paging applies. Nothing essential for correct invocation is missing.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100% for both limit and offset, so the schema already carries full parameter meaning. The description's 'paginated' only gestures at these parameters and adds no format or default details beyond the schema.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb and resource ('List all Vital users in your team') plus the operation's scope, which implicitly separates it from vital_get_user (single user) and vital_create_user. It stops short of naming an alternative sibling explicitly, 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.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Usage is only implied: an agent can infer this is the bulk-listing tool versus vital_get_user or vital_resolve_user, but the description never states when to prefer it or any exclusions. No prerequisites or conditions are given.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Add one secure layer between your agents and this server.