Skip to main content
Glama

Inspect guide index

look_index
Read-only

Retrieve guide metadata and an ordered section index for drafts or finished teaching guides, and optionally include the full content of one section by passing its section ID.

Instructions

Return guide metadata and the ordered section index (no content), or include one full section by passing section_id. Works for drafts and finished guides.

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": {
      "guide_id": "<guide_id>"
    },
    "name": "look_index"
  }
}

Input Schema

NameRequiredDescriptionDefault
guide_idYesGuide id (g_...).
section_idNoOptional section id (s_...) whose full content should be included.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

A3.8/5.0
Behavior4/5

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

Annotations already cover the safety profile (readOnly, non-destructive, closed-world), so the description's job is to add context — and it does, stating that no content is returned unless section_id is passed and that the tool works on both drafts and finished guides. It does not disclose ordering guarantees, index size limits, or whether unpublished draft state affects visibility, which keeps it from a 5.

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 sentences, front-loaded with the default behavior and then the optional mode, with no filler. The trailing clause about drafts and finished guides is short and carries real information rather than padding.

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 two-parameter read tool with no output schema, the description adequately conveys what comes back: metadata plus an ordered section index, or one section's content on request. It could say more about the shape of the index entries, but nothing essential to calling it correctly is missing.

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 coverage is 100%, so both parameters are already documented with id formats (g_..., s_...) and the meaning of section_id. The description restates that passing section_id includes one full section, adding little beyond the schema, so the baseline 3 is appropriate.

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 states a specific verb ('Return') and resource ('guide metadata and the ordered section index'), and clarifies the two modes of operation: index-only by default, or one full section when section_id is supplied. It stops short of naming the likely alternative (read_section) so an agent must infer the boundary, but the core purpose is unambiguous.

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?

'Works for drafts and finished guides' gives useful scope information about when the tool applies. However, it never says when to prefer this over read_section or next_section, leaving the index-vs-content choice to inference from the mode sentence rather than an explicit routing rule.

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