Skip to main content
Glama

Create or update a knowledge-base article

kb_upsert_article
Idempotent

Your organization's knowledge base (not Spun's product documentation; use search_knowledge for that). Create a new article in it, or update an existing manual article by source_id. Live for the AI assistant at once. Re-sending identical title, content and tags is a no-op (status "unchanged"), with or without source_id. Content that exists in or overlaps another article is refused (conflict, naming it): update that article by source_id or change the text. Articles created this way are attributed to this AI connection in the Knowledge Base settings. Nothing is sent to anyone.

Input Schema

NameRequiredDescriptionDefault
tagsNoTags (letters, digits, - and _; at most 10, each up to 30 characters). Case-insensitive.
titleYesArticle title
contentYesArticle text, plain text or Markdown, up to 20000 characters
source_idNoTo update an existing manual article, its source_id. Omit to create a new article.

Output Schema

NameRequiredDescriptionDefault
tagsYes
titleYes
statusYes
source_idYes
chunk_countYes
total_tokensYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.6/5.0
Behavior5/5

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

Goes well beyond the annotations: it explains that re-sending identical title/content/tags is a no-op with status "unchanged" (sharpening idempotentHint into concrete semantics), that overlapping content is refused with a named conflict, that changes are live for the AI assistant immediately, that creation is attributed to this AI connection, and that nothing is sent to anyone. These are exactly the mutation consequences an agent needs before writing.

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?

Front-loaded with purpose and scoping before the behavioural details, and nearly every sentence carries information. It is dense to the point of being cramped, stacking parenthetical asides and status tokens ("unchanged", "conflict") in a single block, which slightly hurts scannability.

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?

An output schema exists, so return values need not be explained, and the description nonetheless surfaces the two meaningful outcomes (unchanged no-op and named conflict). For a two-required-parameter upsert with an idempotency requirement, nothing an agent needs in order to call it correctly 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 description coverage is 100%, so the schema already documents all four parameters including tags format, length limits and source_id's role. The description only adds the nuance that source_id targets *manual* articles, which is a small but real increment over the schema wording. Baseline 3 is appropriate.

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?

States a specific verb pair and resource — 'Create a new article ... or update an existing manual article by source_id' — and immediately rules out the confusable neighbour ('not Spun's product documentation; use search_knowledge for that'). An agent can distinguish this from kb_get_article, kb_list_articles and search_knowledge without reading any schema.

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

Usage Guidelines5/5

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

Gives explicit routing rules: use search_knowledge for product documentation instead, omit source_id to create, supply source_id to update, and on a conflict 'update that article by source_id or change the text'. When-to-use, when-not-to-use and the fallback path under rejection are all present.

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.

Resources