Skip to main content
Glama

Flowie Developer Docs

docs_list_endpoints

Read-onlyIdempotent

List the API's operations (method, path, summary) from the OpenAPI contract, optionally filtered by a substring of the path or summary.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathNoWith format=openapi, return just this path, e.g. /v1/documents/send.
limitNoMax operations (default 50).
filterNoOptional substring filter, e.g. 'documents' or 'lifecycle'.
formatNo'list' for method/path/summary lines (default), or 'openapi' for the raw OpenAPI definition.list

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.8/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, destructiveHint=false, and openWorldHint=false, so the safety profile is covered. The description adds the source of truth (the OpenAPI contract) and the returned field set, but says nothing about pagination/limit behavior beyond default 50 or what the raw 'openapi' format returns. Adequate but thin against an already-covered annotation set.

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?

A single tightly written sentence that front-loads the core action and output, with the optional filtering clause placed second. No filler or restated structured data.

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 read-only listing tool with no output schema, the description supplies the essential shape of what comes back (method/path/summary) and the filtering capability. It stops short of explaining the materially different 'openapi' output mode, though the enum in the schema partly carries that.

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 100%, so all four parameters are documented there, making 3 the baseline. The description adds one useful nuance — the filter matches a substring of the path OR the summary — but does not clarify how that differs from the separate `path` parameter, which behaves differently depending on `format`.

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 (List) and resource (the API's operations from the OpenAPI contract) and even enumerates the returned fields (method, path, summary). This is readily distinguishable from siblings like docs_search or docs_read_page, which retrieve page content rather than endpoint inventories.

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 when this tool fits ('list the API's operations ... optionally filtered'), and the filter examples clarify a discovery use case. However, it never explicitly routes the agent away from docs_search or docs_read_page when looking for endpoint information, leaving the choice to inference.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources