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.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The readOnlyHint annotation already signals safety, and the description adds useful behavioral detail: the HTTP method and path (GET /v2/user) and paginated response behavior. It does not discuss ordering or response shape, but for a simple read-only list that is acceptable.
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?
The description is compact and front-loaded: the core action and scope appear first, followed by the API reference. Every sentence adds useful information without redundancy.
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 simple optional-parameter list operation, the description is largely complete. Combined with the schema and readOnlyHint annotation, an agent can call the tool correctly. It stops short of a 5 because there is no output schema and no mention of the response structure or pagination metadata.
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%, with both 'limit' and 'offset' already documented. The description adds the general notion of pagination but no additional parameter-level meaning, defaults, or edge-case guidance, so the baseline score of 3 is appropriate.
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?
The description clearly states the operation: list all Vital users in the team. It also mentions pagination and the exact API endpoint, making it easy to distinguish from single-user tools like vital_get_user or creation tools like vital_create_user.
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?
The description implies use when you need the full user list rather than a single user, but it does not explicitly name alternatives or state when not to use it. The team-scope and pagination hints provide context, but there is no direct routing to sibling tools.
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.