Skip to main content
Glama

Read the platform guide

platform_guide
Read-onlyIdempotent

How this platform works - read it first: what a version, a feature and data are and how long each lives, what is code and what is a resource, the documentation and tests every version keeps, what the snippet returns, what is imported, what is refused, limits and terms.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "platform_guide"
  }
}

Input Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • addedInput schema / additionalProperties
      Added value: +false
  2. First observed

TDQS

A3.8/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, openWorldHint=false and destructiveHint=false, so safety and side-effect behavior is covered. The description adds the substantive trait of what content is inside, but says nothing about the return format, size, or whether the whole guide comes back at once — relevant for a no-arg documentation tool with 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.

Conciseness4/5

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

A single sentence, front-loaded with the highest-value clause ("How this platform works - read it first") followed by a content inventory. The topic list is dense but every item names a distinct concept, so it earns its length; a bulleted structure would read more easily but the compression is defensible.

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?

With zero parameters, rich safety annotations and no output schema, the description's job is basically to say what the guide contains and why to start here — both are done. The only gap is the shape of the response (guide text vs. structured sections) and how it relates to the many operational siblings beyond the "read first" nudge.

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?

The tool takes zero parameters, so there is nothing for the description to disambiguate; the baseline of 4 applies. The schema correctly declares an empty object with additionalProperties=false, matching the argument-free usage the description implies.

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 establishes the resource ("how this platform works" / the platform guide) and enumerates the conceptual topics it covers: versions, features, data lifetimes, code vs. resource, docs/tests, imports, refusals, limits, terms. It is clearly distinct from the operational siblings (deploy, create_feature, read_logs, etc.), but it never states plainly that it returns documentation text, relying on the title verb "Read" for the action.

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?

"read it first" is an explicit sequencing directive that tells the agent to consult this before the operational siblings — strong, actionable guidance. It stops short of explaining when-not to use it (e.g., once the agent already knows the model) or which sibling to go to after reading.

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.