Skip to main content
Glama

Get Portal Agent Readiness

get_portal_agent_readiness
Read-only

Latest agent-readiness check of the published portal (Agent-Friendly Docs Spec): score, grade, category scores and the checks that did not pass. fixScope 'customer' means the portal content or settings decide the check, 'routebase' that the pipeline covers it. Start a run with manage_portal(action: 'check_agent_readiness'). Requires project context.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
documentationIdYesThe public Id (Guid) of the documentation

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.1/5.0
Behavior4/5

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

Annotations only supply readOnlyHint=true, so the description adds real value: it explains what the result contains, the meaning of fixScope 'customer' vs 'routebase', and the prerequisite that project context is required. It stops short of stating whether a missing/never-run check errors or returns empty.

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?

Three dense sentences, front-loaded with what is returned, then the fixScope semantics, then the prerequisite. Each sentence carries information, though the fixScope clause is slightly compressed and reads like a fragment.

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 no output schema, the description correctly takes on the burden of describing the return values (score, grade, category scores, failing checks) and adds the project-context requirement. Minor gaps remain around error/empty-state behavior and whether results are cached or freshly computed.

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

Parameters3/5

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

There is a single parameter with 100% schema description coverage ('The public Id (Guid) of the documentation'), so the schema already does the work. The description adds no extra meaning about documentationId, which matches the baseline 3 for fully documented params.

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

Purpose5/5

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

States a specific verb+resource ('Latest agent-readiness check of the published portal') and enumerates the payload (score, grade, category scores, failing checks). The parenthetical naming of the Agent-Friendly Docs Spec further anchors it and separates it from unrelated scoring tools like get_security_score or get_governance_score.

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?

Explicitly routes the agent to manage_portal(action: 'check_agent_readiness') to start a run and clarifies that this tool only reads the latest result. It does not name when-not to use it or how to obtain historical runs, but the read-vs-start distinction 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