Skip to main content
Glama

get_index_job

Get the current state of an indexing job: lifecycle status, build phase, timestamps, the published snapshot version when one exists, and a safe error summary when it failed. Use it to poll after submit_index_job or remember_text, and to confirm that a new snapshot is live before querying. Status values: queued, in_progress, published, failed. Returns: job_id, workspace_id, status, phase, created_at, started_at, finished_at, error {code, summary} or null, published_version {id, workspace_id} or null. Errors: JOB_NOT_FOUND when no job with that id exists in the workspace.

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": {
      "job_id": "<job_id>"
    },
    "name": "get_index_job"
  }
}

Input Schema

NameRequiredDescriptionDefault
job_idYesThe job id (UUID) returned by submit_index_job or remember_text.
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. Changed2 schema fields changed
    • addedInput schema / properties / job_id / description
      Added value: +"The job id (UUID) returned by submit_index_job or remember_text."
    • 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.3/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 behavioral burden and does so well: it lists lifecycle status values, discloses a safe error summary on failure, and documents the JOB_NOT_FOUND error. It does not explicitly state read-only semantics, permissions, or rate limits, but the 'get' framing and polling guidance make the operation clear.

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 core purpose, then efficiently covers usage, status values, return shape, and errors. Every sentence contributes useful information without redundancy.

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, but the description explicitly documents the return fields, status values, and error behavior. Combined with complete parameter documentation in the schema, an agent has everything needed to invoke and interpret this tool 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 both job_id and workspace_id are already fully documented in the input schema. The description reinforces job_id's origin from submit_index_job or remember_text and implies workspace scoping via JOB_NOT_FOUND, but adds no syntax or format details beyond the schema.

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: get the current state of an indexing job. It enumerates what is returned (status, phase, timestamps, snapshot version, error summary), which makes the tool clearly distinguishable from submit_index_job and other siblings.

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 clear usage context: poll after submit_index_job or remember_text, and confirm a new snapshot is live before querying. It does not state when not to use the tool or name a concrete alternative for other job-inspection scenarios, so it stops short of full when/when-not guidance.

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