Skip to main content
Glama

Create a snippet

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

TableJSON 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. 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?

The description opens with 'MUTATES KnowledgeOwl data' and specifies the HTTP method, which reinforces the destructiveHint annotation. It also discloses that the tool returns the created snippet, adding value beyond the annotations by describing the operation's effect and response.

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 focused sentences with no wasted words. The mutation warning and endpoint are front-loaded, followed by the key parameter guidance and return behavior — every sentence earns its place.

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 creation tool, the description plus schema covers required parameters, the general behavior, and the return value. It does not describe error cases or prerequisites like authentication, but the annotations and schema provide enough context for an agent to invoke this tool correctly.

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 coverage is 100%, so the schema already documents all three parameters. The description adds valuable meaning by explaining that the snippet body/content should be passed via the fields parameter, with a snippet-specific example ('snippet_text/body'), which helps an agent populate the nested object correctly.

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 a specific verb ('creates'), a specific resource ('reusable content snippet'), and the exact KnowledgeOwl endpoint (POST /snippet.json). This clearly distinguishes it from sibling tools like create_article, create_category, and 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?

Usage is implied through the verb 'creates' and the resource type, but there is no explicit guidance about when to prefer this over alternatives, or when a different tool (e.g., update_snippet/list_snippets) would be more appropriate. No exclusions or conditional routing are provided.

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.