Skip to main content
Glama

Publish solution article

publish_solution_article
Idempotent

Publish a draft Freshservice solution article by setting its status to 2, making approved knowledge base content live for users.

Instructions

Publish a draft article (sets status to 2).

Input Schema

NameRequiredDescriptionDefault
article_idYesSolution article ID

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv2.1.0

TDQS

B3.3/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=false, idempotentHint=true, destructiveHint=false, and openWorldHint=true, so the safety profile is covered. The description usefully adds the concrete side effect (status set to 2) and the draft precondition, but says nothing about visibility changes, notifications to subscribers, or failure modes for non-draft articles.

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?

One short sentence with the action front-loaded and a parenthetical for the concrete effect; no filler or redundancy.

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?

With one required parameter, an output schema, and full annotations, the definition is minimally sufficient to invoke correctly. However, it does not clarify what 'publish' changes beyond the numeric status (e.g., visibility, subscriber notification) or whether publishing is reversible, which matters for a state-transition tool.

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% with a single documented parameter ('Solution article ID'), so the schema carries the burden and baseline 3 applies. The description adds no format, range, or source hints for article_id 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?

Specific verb+resource: 'Publish a draft article' clearly identifies the action and target object, distinct from create/update/delete siblings in the solution-article family. It does not explicitly name a sibling alternative, so it stays below a 5.

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 word 'draft' implies a precondition (the article must already exist as a draft), but no explicit when-to-use, when-not-to-use, or pointer to update_solution_article for status changes. An agent must infer the relationship with the other article tools.

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