Skip to main content
Glama

submit_index_job

Queue Markdown files from the configured read-only input directory for indexing into a workspace's knowledge graph. Returns immediately with a job id; the build runs in the background, so poll get_index_job and only call query_graph after a new snapshot is published. Files are snapshotted when the job is accepted; later edits on disk are not picked up by this job. Shared-filesystem ingestion is disabled on hosted endpoints — use remember_text there. Returns: job_id, workspace_id, status ("queued"), queue_position.

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": {
      "path": "<path>"
    },
    "name": "submit_index_job"
  }
}

Input Schema

NameRequiredDescriptionDefault
pathYesFile or directory path relative to the configured input root. Every Markdown file under it is queued.
sourceNoOptional label prefix stored with the documents; it appears in citations and groups files that belong together.
workspace_idNoWorkspace that owns the graph, 1–63 chars of [a-z0-9-]. Use the same id for every operation on one corpus. Defaults to "default".default

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changed
    • addedInput schema / properties / path / description
      Added value: +"File or directory path relative to the configured input root. Every Markdown file under it is queued."
    • addedInput schema / properties / source / description
      Added value: +"Optional label prefix stored with the documents; it appears in citations and groups files that belong together."
    • addedInput schema / properties / workspace_id / description
      Added value: +"Workspace that owns the graph, 1–63 chars of [a-z0-9-]. Use the same id for every operation on one corpus. Defaults to \"default\"."
  2. First observed

TDQS

A4.7/5.0
Behavior5/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 so well: it discloses that the call returns immediately with a job id, the build runs in the background, files are snapshotted at acceptance, later disk edits are ignored, and hosted endpoints disable this ingestion path. It also lists the immediate return fields.

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?

The description is front-loaded with the primary action and then layers in async behavior, polling guidance, snapshot limits, hosted-endpoint fallback, and return fields. Every sentence adds operational value without repetition.

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

Completeness5/5

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

There is no output schema and no annotations, but the description compensates by explaining the async lifecycle, polling requirement, snapshot timing, hosted limitation, alternative tool, and immediate return shape. This is enough for an agent to invoke and follow up correctly.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so the schema already documents path, source, and workspace_id in detail. The description reinforces the read-only input-root and snapshot semantics for path, but it does not add much parameter-level detail beyond the schema's own descriptions.

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 states a specific verb and resource: queue Markdown files from an input directory for indexing into a workspace's knowledge graph. It also distinguishes the tool from nearby siblings by naming get_index_job, query_graph, and remember_text in the appropriate contexts.

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?

It explicitly says to poll get_index_job after submitting and to call query_graph only after a new snapshot is published. It also states the hosted-endpoint exception and directs users to remember_text when shared-filesystem ingestion is unavailable.

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