Get student
teachworks_get_studentRetrieve one student profile: contact details, school/grade, billing, custom fields, default teachers/services. GET /students/{id}.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| student_id | Yes | Student id. |
teachworks_get_studentRetrieve one student profile: contact details, school/grade, billing, custom fields, default teachers/services. GET /students/{id}.
| Name | Required | Description | Default |
|---|---|---|---|
| student_id | Yes | Student id. |
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true, so the safety profile is covered. The description adds useful behavioral content by enumerating the field groups returned (contact details, school/grade, billing, custom fields, default teachers/services), which matters because there is no output schema. It omits any note on not-found behavior or permissions, keeping it from a 5.
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?
One sentence plus the endpoint reference, front-loaded with the verb and resource and zero filler. Every clause (returned field groups, endpoint) carries 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?
With no output schema, the description usefully summarizes the returned profile contents, and readOnlyHint covers the safety dimension. For a single-parameter read tool this is close to complete; only not-found/error behavior is unaddressed.
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% and there is a single student_id parameter already fully documented, so the baseline is 3. The description adds no format or constraint detail beyond what the schema provides (the accepted integer/string-digits pattern).
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 student profile) and even names the endpoint, so an agent can distinguish it from list_students and from the other get_* siblings. It enumerates the data categories returned (contact, school/grade, billing, custom fields, default teachers/services). It stops short of explicitly naming the sibling it is not, so it falls just under a 5.
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 singular 'one student profile' and the required student_id imply this is the lookup-by-id path rather than the list path, but there is no explicit statement of when to use this over teachworks_list_students or teachworks_get_customer. Usage is inferred rather than stated.
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.