Get a user
goformz_get_userGet one user by id. GET /v2/users/{id}.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| user_id | Yes | User id (a GUID). |
goformz_get_userGet one user by id. GET /v2/users/{id}.
| Name | Required | Description | Default |
|---|---|---|---|
| user_id | Yes | User id (a GUID). |
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true, destructiveHint=false, and openWorldHint=true, so the safety profile is covered. The description adds only the REST endpoint, not error behavior (e.g., not-found handling), auth requirements, or return shape.
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 waste, purpose front-loaded, endpoint appended as a useful locator. Nothing could be removed without losing information.
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 single-param read operation with full annotations and complete schema coverage, this is nearly sufficient. The notable omission is what the user object contains, since no output schema exists, but that is a minor gap for such a simple getter.
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%: the single user_id parameter is documented as a GUID with a regex pattern. The description's 'by id' adds no format detail beyond the schema, fitting the baseline 3.
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 states a specific verb and resource: fetch a single user by id, and adds the underlying REST endpoint. It implies a contrast with list_users via 'one user by id,' but never names the sibling tool explicitly.
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 implied by 'by id' – call this when you already have a user GUID and need that single record rather than a list. No explicit when-to-use guidance, prerequisites, or alternative (list_users) is 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.