Skip to main content
Glama

ingest

Add a URL to the quarry knowledge base: fetch a doc, article, or spec via sitemap discovery or single-page fallback, then let the daemon index it in the background.

Instructions

Use when you have a URL to add to the knowledge base — a doc, an article, a spec.

remember = a specific durable fact, ingest = a URL, learn = a distilled lesson that gets retrieval preference.

Fetches a URL with smart sitemap discovery and single-page fallback. For local files and directories, use register_directory + sync_all_registrations — the daemon owns the filesystem, so there is no in-process file loader here.

Returns immediately — the daemon indexes in the background.

Args: source: HTTP(S) URL to ingest. overwrite: If true, replace a stored URL; if false, skip it. collection: Collection name. Auto-derived if empty.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "source": "<source>"
    },
    "name": "ingest"
  }
}

Input Schema

NameRequiredDescriptionDefault
sourceYes
overwriteNo
collectionNo

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv2.1.0

TDQS

A4.5/5.0
Behavior4/5

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

With no annotations, the description carries the full burden and does most of it well: it discloses that the call returns immediately while the daemon indexes in the background, that fetching does sitemap discovery with single-page fallback, and that overwrite=false causes a skip rather than an error. It stops short of stating permission/auth needs or what happens on fetch failure, which is the remaining gap for a mutating ingest.

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?

The routing information and the primary use case are front-loaded, and each paragraph earns its place. Minor waste: the remember/ingest/learn triad is somewhat compressed and the reStructuredText double-backticks (``register_directory``) are formatting noise in an agent-facing string.

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?

An output schema exists, so return values need not be described, and the description still supplies the one thing an agent must know about returns — that it is asynchronous. Combined with the sibling routing and full parameter coverage, only failure/auth behavior is unaddressed.

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 description coverage is 0%, so the description must compensate, and it does: source is constrained to HTTP(S) URLs, overwrite is explained as replace-versus-skip semantics (not just its name restated), and collection is described as auto-derived when empty. All three parameters gain meaning beyond the bare schema titles.

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 opening line states a specific verb and resource (add a URL to the knowledge base) and gives concrete examples (doc, article, spec). It also explicitly separates ingest from the two nearest siblings — remember is a durable fact, learn is a distilled lesson — so an agent can route correctly without opening 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?

When-to-use is explicit ("Use when you have a URL"), and it names the correct alternative path for non-URL inputs: register_directory plus sync_all_registrations, with the reason (the daemon owns the filesystem). It also disambiguates against remember and learn in a single comparison line.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.