Skip to main content
Glama
Sign In

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 expression is searched as typed. (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

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.4/5.0
Behavior5/5

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

No annotations exist, so the description carries the full burden and does so unusually well: it discloses that query/group are case-insensitive regexes, that an invalid expression is searched literally, that totalCount silently returns 0 when query/group are used, and that an empty result surfaces as a 404 with success:false rather than an empty list. These are exactly the quirks that would otherwise cause an agent to draw false conclusions.

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?

Front-loaded with purpose and the primary use case, then organized into bullets for the two trap behaviours; the density is justified by real pitfalls. The opening two lines are redundant with each other ('List user's guides' / 'Returns a list of guides for the authenticated user'), costing a little.

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?

With no output schema and no annotations, the description covers return shape enough to be safe (guides list, totalCount caveat, 404 error payload) for a 5-parameter filtered list tool. It does not explain pagination behaviour or defaults for page/pageSize, which is the main remaining gap.

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 100%, so the baseline is 3, but the description adds meaning the schema does not: the literal-fallback on malformed regexes, the status exact-match-vs-regex split, and the totalCount blind spot. Pagination parameters (page/pageSize) receive no added semantics, which keeps it from a 5.

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?

States a specific verb+resource ('List user's guides', 'Returns a list of guides for the authenticated user') and scopes it to the authenticated user. It is distinguishable from the singular get_guide sibling only implicitly via 'list', and no sibling is named outright.

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?

Gives an explicit use case with a cost rationale ('Use `query` to check whether a guide already exists before creating one (creating a duplicate costs credits)') and prescribes a fallback procedure ('fall back to an unfiltered paginated scan') when a filtered result is inconclusive. This is genuinely actionable routing guidance rather than a restatement of the name.

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