Skip to main content
Glama

serpmantics

by io.github.AmauryDvl
OverviewDiscussionsAdmin

get_guides

get_guides

List user's guides

Returns a list of guides for the authenticated user.

Use query to check whether a guide already exists before creating one (creating a duplicate costs credits). Beware of two behaviours of this endpoint:

  • query and group are case-insensitive REGULAR EXPRESSIONS, not exact matches: special characters in the value are interpreted as regex syntax, and an invalid regex returns no result at all. (status is different: a known status is matched exactly, any other value falls back to a regex.) Always compare the returned query and source yourself, and fall back to an unfiltered paginated scan before concluding that nothing exists;

  • totalCount does NOT take query nor group into account (known limitation: both are applied as application-level regexes that the count query does not know, so it returns 0 as soon as either is used, alone or combined with status). Filtering on status alone does give a correct totalCount, since it is a real stored field. For an existence check, trust the guides actually returned; totalCount is only reliable for paginating a listing filtered by status alone, or not filtered at all.

An empty result is returned as a 404 with success: false and error: "No guides returned", not as an empty list.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pageNoPage number for pagination
groupNoFilter on the guide group. Case-insensitive partial match, interpreted as a regular expression.
queryNoFilter on the guide query. Case-insensitive partial match, interpreted as a regular expression (see the endpoint description).
statusNoFilter on the guide status. Exact match when the value is one of the known statuses, otherwise a case-insensitive regular expression.
pageSizeNoNumber of guides per page

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changed
    • addedInput schema / properties / group
      Added value: +{
+  "description": "Filter on the guide group. Case-insensitive partial match, interpreted as a regular expression.",
+  "type": "string"
+}
    • addedInput schema / properties / query
      Added value: +{
+  "description": "Filter on the guide query. Case-insensitive partial match, interpreted as a regular expression (see the endpoint description).",
+  "type": "string"
+}
    • addedInput schema / properties / status
      Added value: +{
+  "description": "Filter on the guide status. Exact match when the value is one of the known statuses, otherwise a case-insensitive regular expression.",
+  "enum": [
+    "draft",
+    "active",
+    "review",
+    "published",
+    "archived"
+  ],
+  "type": "string"
+}
  2. First observed

TDQS

A4.8/5.0
Behavior5/5

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

With no annotations provided, the description carries full responsibility and does an excellent job: it discloses regex interpretation, case-insensitivity, invalid regex returning no results, the totalCount limitation with query/group, the exact-match behavior for known statuses, and the 404-on-empty response shape. No contradictions with annotations or schema.

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 description is longer than average but every section earns its place: purpose is stated first, then usage guidance, then important caveats in bullet form. The structure is clear and scannable, with no filler 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?

The description covers key behavioral quirks, the 404 empty result, and totalCount limitations, which is especially important given no output schema. It does not mention default pagination values, maximum page size, or the exact shape of returned guide objects, but the critical usage context is present and sufficient for most calls.

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?

The schema descriptions are mostly present, and the text adds valuable semantics for query, group, and status (regex behavior, exact match for known statuses). However, page and pageSize lack explicit types and defaults, and the description does not clarify pagination conventions such as expected range or default values, leaving some ambiguity.

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 tool's purpose: 'List user's guides' and 'Returns a list of guides for the authenticated user.' It uses a specific verb and resource, and the plural 'guides' distinguishes it from sibling tools like get_guide without ambiguity.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description gives concrete usage guidance: use 'query' to check existence before creating a guide to avoid duplicate credits, and fall back to an unfiltered paginated scan before concluding nothing exists. It also explains when to trust totalCount and warns about behavior that could mislead the caller.

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

All serpmantics toolsInspect
Try in Browser
One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources