Skip to main content
Glama

read_collection

Read-only

Retrieve paged inner collections (Tasks, Comments, etc.) for any entity by resource, ID, and collection name. Use filters, sorting, and field selection to target the needed data.

Instructions

GET an inner collection of an entity, e.g. UserStories/{id}/Tasks or Bugs/{id}/Comments (layer 1), fully paged. See read_meta for collection names.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYes
limitNoMaximum items to return (default 500, max 5000). A capped result says truncated: true.
whereNov1 filter, e.g. (EntityState.Name eq 'Open') and (Project.Id eq 2). Operators: eq, ne, gt, gte, lt, lte, contains, in; no 'or'.
appendNoCalculated values, e.g. [Tasks-Count,Bugs-Count]
excludeNoFields to omit
includeNoFields to return, e.g. [Id,Name,Project[Name],Tasks[Id,Name]]
orderByNoSort field; "Field desc" is accepted
resourceYesResource name (UserStory) or plural path (UserStories); see read_meta
collectionYesCollection name, e.g. Tasks, Comments, Assignments
orderByDescNoSort field, descending

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.1

TDQS

A3.7/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and destructiveHint=false, and the description's 'GET' is consistent. It adds one useful behavior beyond annotations: 'fully paged' (automatic pagination), but it doesn't explain return shape, truncation behavior (covered for limit in the schema), or rate limits. With annotations as baseline, it adds a bit but not rich context.

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 entire description is one sentence: the verb and target are front-loaded, examples are compact, and the reference to read_meta is a purposeful pointer. No filler or repeated schema content.

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 10-parameter tool, the schema covers most parameters and annotations cover the read-only/open-world safety profile. The description supplies the missing path pattern and pagination behavior, and points to read_meta for vocabulary. The main gaps are the unexplained 'layer 1' term and the absence of output-shape guidance, but these are not fatal given schema richness.

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 90%, so the schema handles most parameter documentation. The description adds value by showing how resource, id, and collection combine into a path, and by telling the agent to consult read_meta for valid collection names. This is modest but real meaning beyond the schema fields.

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 opens with 'GET an inner collection of an entity' and gives concrete path examples (UserStories/{id}/Tasks, Bugs/{id}/Comments), so the operation and resource are clear. It distinguishes itself from read_meta by pointing there for collection names, but it doesn't explicitly differentiate from other read_* siblings such as read_comments or read_get.

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?

The description implies usage context: you use it when you need a nested collection of an entity, and it directs the agent to read_meta for valid collection names. It does not state when not to use it or name alternative tools for top-level reads/search, so guidance is implied rather than explicit.

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