Get a user by its ID
gitbook_get_user_by_idRetrieve user details by providing their unique user ID.
Instructions
Get a user by its ID. (GET /users/{userId})
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| userId | Yes | Path parameter: userId. |
gitbook_get_user_by_idRetrieve user details by providing their unique user ID.
Get a user by its ID. (GET /users/{userId})
| Name | Required | Description | Default |
|---|---|---|---|
| userId | Yes | Path parameter: userId. |
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint, idempotentHint, openWorldHint, which fully describe safety and idempotency. The description adds no behavioral context beyond the HTTP method, so it provides minimal added value.
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?
A concise two-sentence description that immediately states the core action and endpoint. No unnecessary 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 simple read operation with one parameter and no output schema, the description is adequate. Combined with annotations, it provides sufficient context for an agent to invoke the tool.
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 coverage is 100% and the single parameter (userId) is described in the schema. The description does not add any extra meaning or examples 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?
The description clearly states the action ('Get') and resource ('a user') and includes the HTTP method (GET /users/{userId}). It is straightforward but does not differentiate from sibling 'get' tools; the name itself distinguishes it.
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?
No guidance on when to use this tool versus alternatives. There are many get tools in siblings (e.g., get_space, get_organization_by_id), and the description offers no context for selection.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
We provide all the information about MCP servers via our MCP API.
curl -X GET 'https://glama.ai/api/mcp/v1/servers/HoYongJin/gitbook-mcp'
If you have feedback or need assistance with the MCP directory API, please join our Discord server