Skip to main content
Glama

Get Doc Version Publish State

get_doc_version_publish_state
Read-only

Whether a documentation version is ready to go live and whether the portal is showing its current content: lifecycle status, visibility, approval state, and whether anything was edited since the last successful portal build. Also names the draft pages that publishing leaves out and the pages linking to them. Read this before publishing or building. Requires project context.

Input Schema

NameRequiredDescriptionDefault
versionIdYesThe public Id (Guid) of the doc version
documentationIdYesThe public Id (Guid) of the documentation

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.9/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, so the safety profile is covered; the description adds real value beyond that by disclosing the scope of what is inspected (draft pages omitted from publishing, pages linking to them) and the prerequisite that project context is required. It does not discuss cost, latency, or behavior when a build has never run, which keeps it from a 5.

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?

Two sentences, front-loaded with the core question ("whether a documentation version is ready to go live") followed by the enumerated facets and the usage trigger. Dense but every clause carries information; the colon-list is efficient rather than padded.

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 carries the burden of describing return content, and it does so by listing the state facets and the draft-page/link information. Combined with the readOnly annotation and fully documented parameters, an agent has enough to call it correctly; only edge-case behavior (e.g., no prior build) is unaddressed.

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 description coverage is 100% and both parameters (documentationId, versionId) are documented as public Guids in the schema, so the baseline of 3 applies. The description's only added signal is the general note that project context is required, which does not clarify either parameter beyond what the schema states.

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 names a specific resource (a documentation version's publish state) and enumerates the concrete facets returned: lifecycle status, visibility, approval state, edit-since-last-build, excluded draft pages, and inbound links. That is far more specific than the title alone and lets an agent distinguish it from siblings like get_publish_history or get_doc_settings, though it never explicitly names those alternatives.

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 this before publishing or building" gives a clear, actionable trigger for when to call it. It stops short of stating when NOT to use it or pointing to the adjacent tools (pre_publish_impact, get_publish_history) that cover overlapping questions, so it is clear context without exclusions.

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