Skip to main content
Glama

KnowledgeOwl MCP by usefulapi

Create a snippet

knowledgeowl_create_snippet
Destructive

MUTATES KnowledgeOwl data: creates a reusable content snippet. KnowledgeOwl API: POST /snippet.json (JSON). Pass the snippet body/content and any other documented field via fields (e.g. snippet_text/body). Returns the created snippet.

Input Schema

NameRequiredDescriptionDefault
nameYesThe snippet name (required).
fieldsNoAdditional documented KnowledgeOwl fields to send in the JSON write body (e.g. current_version, body) — merged OVER the typed fields above.
project_idYesThe knowledge base (project) id this snippet belongs to (required).

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A3.9/5.0
Behavior4/5

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

The description leads with "MUTATES KnowledgeOwl data," consistent with destructiveHint=true, and adds context beyond annotations: the HTTP endpoint, the JSON body format, and the fact that the created snippet is returned. It doesn't cover failure modes or auth requirements, keeping it short of a 5.

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?

Three short, front-loaded sentences: mutation warning first, then endpoint, then parameter and return guidance. No wasted text, though the parameter sentence is slightly redundant with the schema.

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 3-parameter creation tool with a nested free-form object and no output schema, the description covers the write semantics, the endpoint, how to pass additional documented fields, and what comes back. Only extended behavioral details (error handling, permission requirements) are absent.

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 both required params and the `fields` merge behavior are already documented. The description only restates that `fields` accepts the body/content (with a slightly different example set, snippet_text/body vs. schema's current_version/body), so it adds little beyond the schema baseline.

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 and resource ("creates a reusable content snippet") and pairs it with the concrete API operation POST /snippet.json, which clearly separates it from sibling creators like knowledgeowl_create_article or knowledgeowl_create_glossary_term.

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?

The verb 'create' plus the sibling set makes the intended usage fairly obvious, but the description never states when to choose this over alternatives or what prerequisites exist (e.g. required permissions or how the snippet must be scoped to project_id).

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.