Skip to main content
Glama
Sign In

Aide

by app.aide
OverviewDiscussionsAdmin

Update a knowledge article

update_knowledge_article
Destructive

Change a knowledge document's title, body, slug or collection, star it, turn an article into a snippet or back, or keep it out of Aide's answers; once published, Aide answers from the new text at once and, for an article, Aide Chat's public help section shows it. The body replaces the previous one, so start from get_knowledge_document's and change only what is wrong or missing. Returns the document.

Input Schema

NameRequiredDescriptionDefault
kindNo`snippet` to make an article internal (never shown to customers), `article` to make a snippet a draft article.
slugNoIts new help center address, lowercase words joined by `-`.
titleNoThe new title.
bodyHtmlNoThe whole new body, as simple HTML (`<p>`, `<ul>`, `<a>`…).
isStarredNoTrue to star it, false to unstar it.
documentIdYesThe knowledge document id, from list_knowledge_documents or search_knowledge.
usedByAideNoFalse to keep it out of Aide’s answers (a published article still shows in the help section); true to use it again.
collectionIdNoThe collection to file it in, or null for none.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • addedInput schema / properties / kind
      Added value: +{
+  "description": "`snippet` to make an article internal (never shown to customers), `article` to make a snippet a draft article.",
+  "enum": [
+    "article",
+    "snippet"
+  ],
+  "type": "string"
+}
    • addedInput schema / properties / usedByAide
      Added value: +{
+  "description": "False to keep it out of Aide’s answers (a published article still shows in the help section); true to use it again.",
+  "type": "boolean"
+}
  2. Added

TDQS

A4.4/5.0
Behavior5/5

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

Beyond the destructiveHint=true annotation, it discloses the key consequence: the body replaces the previous one entirely. It also states the downstream effects — published text is used by Aide answers immediately and appears in Aide Chat's public help section — and clarifies that usedByAide=false still leaves a published article visible in the help section.

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?

The operational scope is front-loaded in the first sentence, followed by a replacement warning and a return-value note. The opening sentence is dense with comma-separated clauses, but every sentence contributes information.

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

Completeness5/5

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

For an 8-parameter mutation tool with no output schema, the description covers the destructive replacement behavior, the immediate downstream effects, the read-before-write guidance, and the return value ('Returns the document'). Nothing essential to correct invocation is missing.

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 coverage is 100%, so the schema already documents every parameter including kind, usedByAide, isStarred, and collectionId. The description's prose mapping of these options to their effects adds only marginal meaning beyond the schema, so the baseline of 3 applies.

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 names specific verbs and resources: change title/body/slug/collection, star, convert between article and snippet, and exclude from Aide answers. It is clearly distinguishable from siblings like add_knowledge_article, publish_knowledge_document, and get_knowledge_document.

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?

It explicitly directs the agent to start from get_knowledge_document's body and change only what is wrong or missing, which is a concrete workflow instruction tied to a sibling tool. It does not, however, contrast itself against publish_knowledge_document or explain when a publish step is separately required.

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

All Aide toolsInspect
Try in Browser
One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources