Skip to main content
Glama

nws_app_preview_publish

Preview an NWP publish, then confirm whether notifications should be sent, so changes are reviewed before reaching the congregation.

Instructions

Preview an NWP publish, then ask whether notifications should be sent.

Input Schema

NameRequiredDescriptionDefault
entity_typesNo

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3.2/5.0
Behavior3/5

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

With no annotations, the description carries the full burden of disclosing behavior. It does state one useful trait—that the tool pauses to ask about notifications—but it says nothing about whether previews have side effects, are persisted, expire, resemble a commit token, or require authentication. That leaves the safety profile largely undisclosed.

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?

One short sentence with no padding, and the core action comes first. The only cost is the cryptic 'NWP', but the structure is otherwise efficient.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

The output schema covers return values, and the workflow hint covers ordering. However, for a stateful preview step with zero annotations and an undocumented optional parameter, the description is too thin: it does not cover prerequisites, side effects, or parameter meaning.

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

Parameters2/5

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

The only parameter, entity_types, has 0% schema description coverage, and the description says nothing about it: it does not explain what entity types are, what omitting the parameter means as a filter, or what values are valid. With coverage this low, the description should compensate, but it does not.

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 verb plus resource: previewing a publish operation. Together with the matching sibling names nws_app_commit_publish and nws_app_cancel_publish, this lets an agent infer that it is the first step of a preview/commit/cancel triad. However, the description never explicitly contrasts this tool with those siblings, and the acronym 'NWP' is unexplained.

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?

The phrase 'then ask whether notifications should be sent' implies that this tool is a pre-commit step and that the agent should collect user intent before proceeding. However, the description never names nws_app_commit_publish as the follow-up or says when not to use this tool; the usage guidance is only implied.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

Other Tools