Skip to main content
Glama

ringkit_start_knowledge_import

DestructiveIdempotent

Step 2: Teach it the business. Import the business website into the knowledge profile in the background: returns the queued import; poll ringkit_get_latest_knowledge_import until done or failed. Only fields that are still empty are filled; uploaded documents are never touched. An unfinished import is returned instead of starting another. Identical requests are deduplicated for 24 hours; use a new idempotencyKey only to deliberately repeat the action.

Input Schema

NameRequiredDescriptionDefault
urlYes
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

A4.5/5.0
Behavior5/5

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

Beyond the annotations, the description discloses that the work is asynchronous and queued, that only empty fields are filled, that uploaded documents are protected, that an unfinished import is returned rather than duplicated, and that identical requests are deduplicated for 24 hours. These are exactly the mutation-side behaviors an agent needs and cannot get from the hints. The only mild tension is with destructiveHint=true, which the 'only empty fields are filled' phrasing softens rather than contradicts.

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?

It is front-loaded with the workflow position ('Step 2') and the action, then layers polling, fill semantics, and idempotency in short clauses. Dense but every clause carries information; the only cost is a slightly telegraphic register ('Teach it the business') that takes a beat to decode.

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 an async, no-output-schema mutation, the description covers the essentials: what is started, that a queued handle comes back, and how to poll for completion. It omits failure modes (invalid or unreachable URL, business not yet created) and what the import actually crawls, which would help an agent handle the error path without guessing.

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 67% and the undocumented parameter is `url`, which the description implicitly defines as the business website to crawl. It also adds dedup/retry semantics for idempotencyKey that go beyond the schema text. It stops short of stating URL format constraints (scheme, whether a path or subdomain is allowed) for the one bare parameter.

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 and resource: 'Import the business website into the knowledge profile in the background.' It also distinguishes itself from related siblings by noting that 'uploaded documents are never touched' (contrast ringkit_upload_knowledge_document) and by naming ringkit_get_latest_knowledge_import as the polling counterpart.

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 concrete follow-up guidance: poll ringkit_get_latest_knowledge_import 'until done or failed,' and states when to reuse vs. regenerate the idempotencyKey. The gap is that it never explains how this differs from the sibling ringkit_import_knowledge, so an agent choosing between the two import paths must infer the distinction from the name alone.

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