Skip to main content
Glama

Check publish readiness

publish_readiness
Read-only

Check if the project is ready to publish. ready:false with topologyHint names each service missing its deploy config in the run config. live.services lists every published surface (site and backends).

Input Schema

NameRequiredDescriptionDefault
project_idNoProject id (or use session from use_project)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.7/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, destructiveHint=false and openWorldHint=false, so safety is covered. The description usefully goes further by disclosing the failure shape ('ready:false with topologyHint names each service missing its deploy config') and the meaning of live.services, which tells the agent what to do with an unready result. It omits any note on permissions or what a fully-ready payload contains.

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 short sentences, purpose front-loaded, no filler. The middle sentence is dense field notation (ready/topologyHint) that reads slightly like schema shorthand, but nothing is wasted.

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 read-only one-parameter check with no output schema, the description covers the important outcomes: the boolean readiness flag, the blocking-service hint, and the published-surfaces list. It is nearly complete; only a hint about what to call next on failure is missing.

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?

Schema coverage is 100% and the single project_id parameter carries a description plus the 'use session from use_project' fallback. The description adds nothing about the parameter, so baseline 3 applies — the schema does all the work.

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?

States a specific verb and resource: 'Check if the project is ready to publish.' It is clearly a pre-flight diagnostic, distinguishable in spirit from publish_app (which performs the publish) and get_status/get_services, though no sibling is named explicitly.

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

Usage Guidelines3/5

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

Usage is only implied by the name and the phrase 'ready to publish' — an agent can infer it should be run before publish_app, but the description never says when to use it, when not to, or which alternative (get_status, get_deployment) answers a different question.

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