Skip to main content
Glama

List annotations

list_annotations
Read-only

Retrieve and filter project annotations by status, type, or priority to identify open issues needing attention.

Instructions

List a project’s annotations, optionally filtered by status, type, or priority. Start here with status "open" to see what needs fixing.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
typeNo
limitNoPage size, 1-200 (default 50).
offsetNo
statusNo
priorityNo
project_idYesThe id of the project to list annotations for.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
itemsYes
limitNo
totalNo
offsetNo
Behavior3/5

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

Annotations already declare readOnlyHint=true and destructiveHint=false, so the safety profile is covered. The description adds only a usage hint and does not disclose additional behavior such as pagination behavior, sorting, or filter combination logic. With annotations in place, this is acceptable but not outstanding.

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 concise sentences, front-loaded with the core purpose followed by a practical usage tip. Every word earns its place; no filler or redundancy.

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?

The description is complete for a list operation given that an output schema exists and annotations cover safety. It clearly states purpose, filters, and a starting point. It could be slightly richer by noting filters are combinable, but it is not a significant gap.

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 description coverage is low (33%), with only project_id and limit having descriptions. The description mentions the three filter parameters (status, type, priority) and gives a concrete example for status ('open'), adding some meaning. However, it does not explain offset or how filters combine, leaving the agent to rely on enums and names.

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?

The description clearly states the action ('List a project's annotations') and the optional filters (status, type, priority), which is a specific verb+resource. It naturally distinguishes from sibling tools like list_comments or list_annotation_issues by focusing on annotations themselves.

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?

The description provides clear usage context with 'Start here with status "open" to see what needs fixing,' indicating when to use this tool. It does not explicitly mention alternatives or exclusions, but the guidance is strong enough that it earns a 4.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/UseVynix/vynix-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server