Skip to main content
Glama
mcp-library-docs

mcp-library-docs

by roznet

get_index_status

Checks INDEX.md against actual design doc files to reveal missing docs and stale entries, so you know what to add or remove before updating the index.

Instructions

Returns the status of INDEX.md compared to actual design doc files. Shows which docs are missing from INDEX.md and which INDEX entries are stale. Use this before updating INDEX.md to see what needs to be added or removed.

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": {
      "cwd": "<cwd>"
    },
    "name": "get_index_status"
  }
}

Input Schema

NameRequiredDescriptionDefault
cwdYesCurrent working directory of the Claude session

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.8/5.0
Behavior3/5

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

No annotations are supplied, so the description carries the full burden. It implies a read-only, non-mutating inspection via 'Returns' and 'Use this before updating,' and discloses what the two result categories mean, but it does not confirm that nothing is written, describe failure behavior for a bad cwd, or explain output shape. Adequate for a simple status check, but not rich.

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?

Three short sentences, front-loaded with what it returns and ending with the workflow cue. Every sentence contributes: purpose, result detail, and timing of use, with 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 a one-parameter read tool with no output schema and no annotations, the description covers purpose, result content, and intended workflow timing. The only real gap is a precise description of the returned structure, which is a minor omission given the stated result categories.

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?

There is a single required parameter, cwd, and schema coverage is 100% with an inline description, so the schema already does the work. The description adds no meaning about how cwd affects resolution of INDEX.md or the doc files, leaving it at the baseline.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/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 ('Returns the status of INDEX.md compared to actual design doc files') and even enumerates the two kinds of results (missing docs, stale entries), so the agent knows exactly what it produces. It does not explicitly contrast itself with siblings like get_design_doc, but the resource is distinct enough that confusion is unlikely.

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?

'Use this before updating INDEX.md to see what needs to be added or removed' gives a clear triggering context and ordering relative to an update workflow. It stops short of naming alternatives or stating when not to use it, so it is strong context without full routing guidance.

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

Deploy Server

Other Tools