Get agent
textline_get_agentRetrieve one agent (user) by UUID or email: name, permission level, availability (on_call) and departments. GET /api/users.json.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| No | Agent email. | ||
| user_uuid | No | Agent UUID. |
textline_get_agentRetrieve one agent (user) by UUID or email: name, permission level, availability (on_call) and departments. GET /api/users.json.
| Name | Required | Description | Default |
|---|---|---|---|
| No | Agent email. | ||
| user_uuid | No | Agent UUID. |
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already cover readOnly, idempotent, non-destructive and openWorld, so the safety profile is handled. The description adds real value by disclosing the returned fields (name, permission level, on_call availability, departments) and the underlying endpoint, which is meaningful given there is no output schema.
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 single tight sentence, with the resource and lookup keys front-loaded and the returned fields trailing; every clause 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 small read-only lookup with fully documented params, this covers what an agent needs, and it partially compensates for the absent output schema by naming returned fields. It stops short of explaining behavior when both keys are omitted or how the two keys interact.
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% with patterns and descriptions for both email and user_uuid, so the schema carries the parameter burden. The description restates the two lookup keys but adds no format or precedence detail (e.g., which wins if both are given), so baseline 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?
States a specific verb (Retrieve) and resource (one agent/user), names the two lookup keys (UUID or email), and enumerates the returned fields. This clearly differentiates it from the sibling list_agents, which returns many.
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 single-record lookup but never explicitly says when to use this vs textline_list_agents or what to do if neither email nor UUID is supplied (0 required params). Usage context is implied, not stated with alternatives or exclusions.
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.