Skip to main content
Glama

Read an authoritative planning definition

get_planning_schema_definition
Read-onlyIdempotent

Read one to twenty published references together in schema_refs, including a one-element list for one definition. Collect known references for the next action and batch them instead of calling once per field. Returns definitions keyed by reference and shared, reference-closed components. Reuse them at the same name/version; profile output and profile_patch input are distinct. result_list describes the lightweight list projection; result_reading describes expanded user-facing detail and field meanings, not integer record tables from the separate full-reading API. Invalid references or oversized batches fail explicitly; split a rejected batch without omitting constraints. Avoid full profile definitions unless needed. Requires the authenticated One U Education account and declared planning scope; credentials and user identity are never tool arguments.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "name": "<name>",
      "schema_refs": "<schema_refs>"
    },
    "name": "get_planning_schema_definition"
  }
}

Input Schema

NameRequiredDescriptionDefault
nameYes
versionNoReuse definitions only for the same schema name/version. Only the current version is served.
schema_refsYesCollect needed published schema_ref values and read them together, even for one reference. Same schema name/version only; definitions are keyed by reference and components are shared. Invalid references or an oversized batch fail explicitly.

Output Schema

NameRequiredDescriptionDefault
msgYes
codeYes
dataYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedInput schema / properties / name / enum
      Previous value: -[
      -  "profile",
      -  "profile_patch",
      -  "planning_settings",
      -  "result_reading",
      -  "result"
      -]New value: +[
      +  "preferences",
      +  "profile",
      +  "profile_patch",
      +  "planning_settings",
      +  "result_reading",
      +  "result_list",
      +  "result"
      +]
  2. Added

TDQS

A4/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare read-only, idempotent, open-world, non-destructive behavior, and the description adds meaningful context beyond that: authentication and planning scope requirements, explicit failure on invalid references or oversized batches, and batching guidance. It does not contradict any annotation.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The core instruction is front-loaded, and most sentences add useful operational detail. It is somewhat dense and repeats a few schema constraints, but the structure remains functional for a tool with several behavioral nuances.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the annotations and output schema, the description covers the main operational concerns: batching, version consistency, failure behavior, authentication, and distinctions among schema types. The main remaining gap is that it does not explicitly point to the sibling tool for discovering schema references.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is moderate at 67%, and the description adds meaningful semantics beyond the schema, especially for schema_refs batching, version reuse, and ambiguous name values such as profile/profile_patch and result_list/result_reading. Some enum values remain unspecified, but the key ambiguities are addressed.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states that the tool reads one to twenty schema references at once and returns definitions keyed by reference. It distinguishes this from the separate full-reading API and clarifies result_list versus result_reading, though it does not explicitly name the sibling get_planning_schema_index.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

It gives useful usage context: batch known references instead of calling once per field, avoid full profile definitions unless needed, and treat profile versus profile_patch distinctly. It lacks an explicit 'use this instead of X when Y' comparison against the schema index sibling, but the guidance is clear.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources