Retrieve the list of students in your class from Edupage. Optionally specify a school subdomain when managing multiple schools to get a JSON array of student records.
Get students in your class.
Args: school: School subdomain (only needed with multiple schools).
Returns: JSON array of lean student records
| Name | Required | Description | Default |
|---|---|---|---|
| school | No |
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |
Changes observed during successful MCP inspections.
v0.2.0Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Returns JSON array of lean student records and explains the school parameter's condition. No annotations provided, so description carries burden; minimal but adequate disclosure of behavior.
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?
Very concise with two sentences, front-loaded purpose. Could be slightly more structured (e.g., bullet points) but efficient.
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 1-parameter tool with output schema, the description is adequate but lacks details like ordering, pagination, or explanation of 'lean' records. Siblings are numerous but not addressed.
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 0% but description adds meaning for the only parameter: 'School subdomain (only needed with multiple schools).' This is valuable beyond the schema's default value.
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?
Clearly states 'Get students in your class' with a specific verb and scope. However, sibling 'get_all_students' exists and there is no differentiation, slightly reducing clarity.
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 like 'get_all_students' or other teacher-specific tools. Does not mention prerequisites or context.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.