Skip to main content
Glama

create_kb_doc

Add one knowledge base source (VG agents). For many page URLs use create_kb_from_urls instead. For websites: sourceType=url with urls[] + scrapeContent=true (KB router scrapes). For whole-site: sourceType=sitemap + sitemapUrl + maxPages + scrapeContent=true. sourceType=doc only for raw text you already have — do not paste web-fetched HTML here.

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": {
      "agentId": "<agentId>",
      "name": "<name>",
      "sourceType": "<sourceType>"
    },
    "name": "create_kb_doc"
  }
}

Input Schema

NameRequiredDescriptionDefault
nameYesDocument name
tagsNoTags for organization
urlsNoArray of URLs (for sourceType: url). Prefer create_kb_from_urls for many pages.
agentIdYesThe agent ID
contentNoDocument content (required for sourceType: doc)
maxPagesNoMax pages from sitemap
metadataNoAdditional metadata
sitemapUrlNoSitemap URL (for sourceType: sitemap)
sourceTypeYesdoc = text; url = KB router scrape urls[]; sitemap = crawl sitemap
refreshRateNoAuto re-crawl for URL/sitemap (API: 3d | 7d | never). Default never.
scrapeContentNoLet KB router scrape URLs/sitemap (set true for url/sitemap)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.6/5.0
Behavior4/5

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

Annotations already declare the safety profile (readOnlyHint=false, openWorldHint=true, idempotentHint=false, destructiveHint=false). Beyond that, the description discloses that the KB router itself performs scraping for url/sitemap sources, which is genuinely behavioral context an agent would not get from annotations. It omits failure modes, quota limits (get_kb_quota exists as a sibling) and whether repeated calls create duplicates.

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?

Front-loads purpose, then alternative, then one compact recipe per sourceType. Telegraphic phrasing, but every clause carries a distinct decision rule and there is no filler.

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 11-parameter mutation with no output schema, the description covers the hard part — selecting the right sourceType and correct field combination. Minor gaps remain: nothing about what is returned (created doc id), whether the call blocks on scraping, or quota/limit constraints.

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?

With 100% schema coverage, per-parameter meanings are already documented, so the baseline is 3. The description goes further by specifying cross-parameter dependencies — which fields are required together for each sourceType and that scrapeContent must be true for url/sitemap — information the flat schema cannot express.

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?

Opens with a specific verb and resource: 'Add one knowledge base source (VG agents).' It immediately scopes to a single source and names the sibling (create_kb_from_urls) it is not, so an agent can distinguish it without opening either 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?

Gives explicit routing rules: many page URLs → create_kb_from_urls; individual/website → sourceType=url with urls[] + scrapeContent=true; whole-site → sourceType=sitemap with sitemapUrl + maxPages; raw text → sourceType=doc. It also states a negative constraint ('do not paste web-fetched HTML here'), leaving nothing to inference.

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