Skip to main content
Glama
tannertm0
by tannertm0

update_solution_article

Modify an existing knowledge base article by updating its title, description, status, or tags to maintain accurate and current information in the Freshservice ITSM platform.

Instructions

Update an existing knowledge base article

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
article_idYesThe article ID to update
titleNo
descriptionNo
statusNo
tagsNo
Behavior2/5

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

With no annotations provided, the description carries full burden for behavioral disclosure. It states the tool updates an article but doesn't mention required permissions, whether changes are reversible, rate limits, or what happens to unspecified fields. For a mutation tool with zero annotation coverage, this is a significant gap in behavioral context.

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, efficient sentence with zero waste. It's appropriately sized and front-loaded, directly stating the tool's core function without unnecessary elaboration.

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

Completeness2/5

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

For a mutation tool with 5 parameters, 20% schema coverage, no annotations, and no output schema, the description is inadequate. It lacks behavioral context, parameter details, and output expectations, making it incomplete for safe and effective use by an AI agent.

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?

Schema description coverage is only 20% (only article_id has a description), and the description adds no parameter information beyond what's implied by 'update an existing knowledge base article'. It doesn't explain what title, description, status, or tags represent, their formats, or constraints, failing to compensate for the low schema coverage.

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 clearly states the verb ('update') and resource ('existing knowledge base article'), making the purpose unambiguous. It distinguishes this from creation operations but doesn't explicitly differentiate from other update tools like update_asset or update_ticket, which would require 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 description provides no guidance on when to use this tool versus alternatives. It doesn't mention prerequisites (like needing an existing article), exclusions, or comparisons to sibling tools like create_solution_article or delete_solution_article, leaving the agent without contextual usage cues.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/tannertm0/freshservice-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server