Skip to main content
Glama
cog-sh
by cog-sh

index_now

Trigger an incremental vault index update so coding agents can search and read your notes after changes. Pass full=true to re-embed everything; looped runs exit safely.

Instructions

Run the vault indexer now (incremental; full=True re-embeds everything).

Concurrent runs are safe: the indexer holds a lock and a second run exits immediately.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
fullNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.2/5.0
Behavior4/5

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

With no annotations present, the description carries the full burden and does disclose meaningful behavior: the lock-based concurrency model and that a competing run exits immediately, plus the fact that 'full=True' re-embeds everything (a costly, potentially long operation). It omits expected duration, whether the call blocks the caller, and any permission requirements.

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?

Two short sentences, no filler. The primary action is front-loaded and the concurrency caveat follows, so the most important information comes first.

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 mutation/concurrency behavior is covered. What remains thin for a state-mutating indexer is the absence of any note on typical runtime, resource cost, or whether the caller is blocked while indexing runs.

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 coverage is 0% and the 'full' property has no description, so the description must compensate — and it does, explaining that the default is incremental while 'full=True' re-embeds everything. Minor gap: no detail on cost/runtime tradeoffs of full mode.

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?

States a specific verb and resource: 'Run the vault indexer now', with an explicit scope modifier ('incremental' by default). No sibling tool (vault_status, list_notes, semantic_search, etc.) performs indexing, so an agent can route to it unambiguously.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Implies use when the index needs refreshing, and the 'full=True' note hints at the choice between incremental and full runs. However, it never states when an agent should trigger re-indexing versus relying on existing state, nor any prerequisites before calling.

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