Skip to main content
Glama

create_help_document

Create a new blank ProductNow help document. Only available to ProductNow users. Returns the document ID, help page publication ID, and a URL to the document editor where content can be added.

Input Schema

NameRequiredDescriptionDefault
categoryNoHelp page category — one of: GETTING_STARTED, CONTENT_CREATION, COLLABORATION, ADMINISTRATION, OTHER. Defaults to OTHER if omitted.

Output Schema

NameRequiredDescriptionDefault
urlYes
documentIdYes
helpPagePublicationIdYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4/5.0
Behavior4/5

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

Annotations declare readOnlyHint=false and destructiveHint=false, which are sparse; they don't indicate mutation or destructive behavior clearly. The description adds substantial behavioral context: it states it creates a new blank document, is only for ProductNow users, and returns specific identifiers (document ID, help page publication ID, and editor URL). This goes beyond annotations and helps the agent understand the side effects and output.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

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

The description is a single, well-structured paragraph that front-loads the purpose ('Create a new blank ProductNow help document'), followed by audience restriction, and then the return value. Every sentence adds value; there is no fluff. It is concise and informative.

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?

The description covers the action, audience, and return values. It lacks explicit instructions on prerequisites beyond 'ProductNow users' (e.g., authentication or specific permissions), and it doesn't specify what 'blank' means for the help document (e.g., does it have any default content?). However, the output schema (which is not shown but indicated) likely details the return structure, so the description is sufficient for basic invocation. It is complete enough for an agent to understand the essential steps.

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 schema already describes the 'category' parameter with an enum and default, and the description's coverage is 100%. However, the description adds no additional semantic meaning for the parameter itself . But since the schema is exhaustive and the parameter is optional with a clear default, the description doesn't need to add much. The score is high because the schema covers it fully, and the baseline for high coverage is 3, but the description's mention of 'new blank' hints that category might influence the document type, adding slight value. I'll give 4 for the alignment.

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?

The description clearly states the verb ('Create'), the resource ('new blank ProductNow help document'), and the audience restriction ('Only available to ProductNow users'). It distinguishes this from siblings like 'create_document' by specifying 'help document' and the editor URL, which implies it's a special kind of document. The purpose is unambiguous.

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

Usage Guidelines2/5

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

The description mentions availability to ProductNow users, which is a prerequisite, but it does not explicitly state when to use this versus siblings like 'create_document' or 'import_prototype'. It doesn't provide exclusions or alternatives. The agent must infer the use case from the name and description.

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.