Skip to main content
Glama

Update a category

update_category
Destructive

MUTATES KnowledgeOwl data: updates an existing category. KnowledgeOwl API: PUT /category/{id}.json (JSON — only included fields change). Use the fields passthrough for any other documented field. The path id is never sent in the body.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesThe category id to update (path only; required).
nameNoNew category name.
fieldsNoAdditional documented KnowledgeOwl fields to send in the JSON write body (e.g. current_version, body) — merged OVER the typed fields above.
statusNoNew publishing status.
url_hashNoNew URL slug.
visibilityNoNew visibility.

Schema Changelog

Changes observed during successful MCP inspections. Dates show when Glama detected each change.

  1. First observed

TDQS

A4.2/5.0
Behavior4/5

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

Annotations only give destructiveHint=true; the description adds HTTP PUT, partial-update semantics ('only included fields change'), and the fact that the id is path-only. This materially clarifies side effects, though it does not cover auth, error, or failure behavior.

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?

Three short sentences lead with the operative verb and pack only non-redundant details: mutation, endpoint, partial-update behavior, passthrough, and id placement. Nothing is wasted.

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?

For a partial-update tool with a rich schema and no output schema, the description gives enough to invoke correctly: resource, method, partial-update semantics, id placement, and passthrough behavior. It could mention the return value, but that is not essential for invocation.

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?

Schema covers all six parameters, so the baseline is 3; the description adds meaning beyond the schema by explaining the 'fields' passthrough and clarifying that the id is never sent in the JSON body. This prevents body/path confusion.

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?

Description identifies the exact action ('updates') and resource ('existing category'), and 'MUTATES' distinguishes it from non-mutating category tools; 'existing' rules out creation. Clear and unambiguous even without opening the schema.

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?

Use is implied: update an existing category, with the 'fields' passthrough for other documented fields. But it does not name alternatives like create_category or update_article, nor state when not to use this tool.

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.

TDQS

A3.8/5.0
Disambiguation5/5

Each tool has a clearly distinct purpose targeting a specific resource (article, category, glossary, etc.) and action (create, get, list, update). There is no ambiguity or overlap between tool names.

Naming Consistency5/5

All tools follow a consistent verb_noun pattern: create_X, get_X, list_X, update_X. The exception 'knowledgeowl_request' is a utility escape hatch, clearly marked, and does not break the overall pattern.

Tool Count4/5

At 24 tools, the set is slightly above the typical 3-15 range but still well-scoped for a knowledge base API covering many resources. Each tool serves a distinct purpose, and no tools are redundant.

Completeness2/5

The tool set lacks delete operations for all resources, and update operations are only available for articles and categories. Missing get tools for glossary terms, snippets, and other resources, though list tools are provided. This leaves significant gaps in lifecycle coverage.