Skip to main content
Glama

Browse the planning schema directory

get_planning_schema_index
Read-onlyIdempotent

Discover unfamiliar fields. Omit index_ref for the root; each scope includes topic index_ref links, so follow the needed topic directly without first opening its scope. Follow returned references for nested records, dictionary values and variants. Collect the needed schema_ref values across topics, then read them together with get_planning_schema_definition. Reuse cached directories and definitions at the same schema name/version. Priorities are interview order, not requiredness. Do not explore unrelated topics or read schema before every save. 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>"
    },
    "name": "get_planning_schema_index"
  }
}

Input Schema

NameRequiredDescriptionDefault
nameYes
versionNoOnly the current returned version is served.
index_refNoOmit for the root directory. Copy a returned index_ref unchanged to navigate people, topics, records, dictionary values or variants; references belong to one schema name/version.

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.2/5.0
Behavior4/5

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

Annotations already declare readOnly, idempotent, non-destructive, closed-world behavior, so the safety profile is covered; the description adds useful context beyond that: authentication via the One U Education account, the declared planning scope requirement, the guarantee that credentials and identity are never tool arguments, and caching expectations across calls at the same schema name/version. It does not describe error or empty-result behavior, but with annotations and an output schema in place this is a minor gap.

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 (discover fields, omit index_ref for root) is front-loaded, and each subsequent sentence carries a distinct rule about navigation, batching, caching, or exclusions. The clipped imperative style is dense and occasionally telegraphic, but nothing is redundant.

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?

For a three-parameter schema-browsing tool with an output schema, annotations, and authentication notes, the agent has enough to call it correctly and to know what to do with the results. The only real gap is the absence of any hint about pagination or directory size limits, which is a modest omission given the declared closed-world scope.

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 67%, and the description compensates by explaining that index_ref must be omitted for the root, that each scope returns topic index_ref links usable directly, that references must be copied unchanged, and that references are bound to a single schema name/version. It also cues collection of schema_ref values for a follow-up call. It adds real navigational meaning beyond the schema's terse parameter docs.

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 states the tool is for discovering unfamiliar fields and describes browsing a root directory, per-scope topic index_ref links, and following references to nested records, dictionary values and variants. Combined with the title this pins down the verb and resource clearly, and it implicitly separates the tool from get_planning_schema_definition by assigning that sibling the 'read the actual definition' role. The opening sentence is a little oblique about return shape, but scope is unmistakable.

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

Usage Guidelines5/5

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

It gives explicit operational rules: omit index_ref for the root, skip opening a scope when a topic link is already present, collect schema_ref values across topics and then batch-read them with get_planning_schema_definition, and reuse cached directories at the same name/version. It also names exclusions — do not explore unrelated topics and do not read schema before every save — and clarifies that priority order is interview order, not requiredness. This is when-to-use, when-not, and named-alternative guidance in one place.

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