Skip to main content
Glama

ringkit_import_knowledge

Destructive

Step 2: Teach it the business. Crawl the business website now and draft a knowledge profile (hours, services, FAQs...). Set apply=true to save it, or review and use put/patch. Reuse an idempotencyKey when retrying; without one, each call executes again.

Input Schema

NameRequiredDescriptionDefault
urlYes
applyNo
businessIdNoDefaults to the business of the API key in the Authorization header.
idempotencyKeyNoOptional. Retries of the same call should reuse it (the stored result comes back); a new value deliberately repeats an identical call. The MCP POST's Idempotency-Key header takes precedence.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.9/5.0
Behavior4/5

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

Annotations already declare destructiveHint=true and idempotentHint=false, and the description goes beyond them by explaining the retry consequence ('without one, each call executes again') and the apply gate that controls whether anything is persisted. What it does not disclose is what apply=true overwrites when a knowledge profile already exists, which matters given the destructive hint.

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 compact sentences, front-loaded with the step framing and the action, then the commit/retry mechanics. 'Step 2: Teach it the business' is conversational framing rather than specification, and 'put/patch' names operations without saying which sibling tools, which costs a little clarity.

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

Completeness3/5

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

For a destructive, open-world mutation with no output schema, the definition covers the commit switch and retry semantics but not what the draft response contains or what happens to existing knowledge on apply=true. It is workable, but an agent would still have to probe the result to know what it got back.

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 only 50%, with url and apply undocumented in the schema, so the description carries real weight here. It clarifies that the URL is the business website to crawl and that apply=true is the commit switch, while the idempotencyKey explanation matches the schema's own note. The 'review and use put/patch' phrasing leaves the follow-up call slightly ambiguous.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description states a concrete verb and resource: crawl the business website and draft a knowledge profile covering hours, services and FAQs. That is far more specific than the bare name 'import_knowledge'. It does not, however, distinguish this tool from the closely named sibling ringkit_start_knowledge_import, so an agent must guess which import entry point to use.

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 gives a clear operating path: call to draft, then either set apply=true to save or review and follow up with put/patch. The retry guidance ('reuse an idempotencyKey when retrying') is explicit and actionable. Missing is any statement of when NOT to use this tool, or how it relates to start_knowledge_import and upload_knowledge_document.

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