Skip to main content
Glama

read

Retrieve a correlated, time-ordered timeline of events matching label selectors across sources or a chosen project, optionally with full payloads for investigation.

Instructions

Read one correlated, time-ordered timeline of everything matching selector across all sources, or only a project's sources, or only the sources you name. selector is a {label: value} conjunction, matched with strict AND, e.g. {"repo": "frontend"} or {"service": "api-server", "endpoint": "/login"}. An event matches only if it carries every named label with that value, so adding a label narrows and removing one widens. Use this to investigate any entity on the fly; once you know which sources matter, create_trigger() over them. Set include_payload when the one-line summaries aren't enough and you need each event's full lossless record: the return becomes JSON {timeline, events[]} where each event carries raw. With a project key the read covers that project only, its findings included.

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": {
      "selector": "<selector>"
    },
    "name": "read"
  }
}

Input Schema

NameRequiredDescriptionDefault
windowNo15m
projectNo
sourcesNo
selectorYes
include_payloadNo

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.57.0

TDQS

A4.2/5.0
Behavior4/5

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

With no annotations, the description carries the burden and does substantial work: it discloses the strict-AND match semantics of the selector, that adding or omitting labels widens/narrows results, that a project key restricts scope to that project including its findings, and that `include_payload` changes the return shape from one-line summaries to {timeline, events[]} with per-event `raw` records. It does not mention cost, rate limits, or behavior on zero matches.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Purpose and scope lead, selector semantics follow, then usage guidance, then the payload flag. Every sentence carries information and there is no filler. It is dense but readable; the project-scoping sentence appended at the end would read better grouped with the other scoping text in the opening sentence.

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

Completeness3/5

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

The tool is moderately complex (nested selector object, five parameters) and an output schema exists, so return values need not be re-explained. The description covers matching, scoping, and payload behavior well, but leaves `window` undefined and says nothing about outcomes when the selector matches nothing — a realistic case for a label-conjunction query.

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%, so the description must compensate, and it does for four of five parameters: `selector` gets conjunction semantics plus two concrete examples, `sources` and `project` get scoping rules, and `include_payload` gets an explicit effect on output. The `window` parameter is never mentioned, leaving the timeline's time span entirely to the schema's bare "15m" default.

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?

"Read one correlated, time-ordered timeline of everything matching `selector`" names a specific verb and a precisely scoped resource (a merged, chronologically ordered timeline), and the source-scope variants (all sources / one project / named sources) are spelled out. An agent can distinguish this from create_trigger without opening either schema.

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 to investigate any entity on the fly; once you know which sources matter, create_trigger() over them" gives an explicit exploratory use case plus the hand-off condition to a named sibling. It also explains the narrowing/widening behavior of the selector, which guides iteration. It stops short of stating when this tool should NOT be used (e.g. versus read_global_docs or other read siblings).

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