Skip to main content
Glama

spring_guides

List all spring.io guides or read one as markdown. Filter by topic to keep only matching catalogue entries or heading sections.

Instructions

List the spring.io guides, or read one guide as markdown.

No guide → the catalogue (title, url, type, category, description) from spring.io's own guide data: the HTML index is rendered client-side, so scraping it yields no guides at all, and the sitemap fallback yields URLs without titles. topic filters the catalogue by title, slug, category or description.

guide → that guide as markdown. Guide pages are server-rendered even though the index is not, so "gs/spring-boot", "accessing-data-jpa" or a full https://spring.io/guides/… URL all work. topic then keeps only the matching heading section, as java_docs(topic=...) does. max_tokens truncates (estimated as len(text)//4).

On failure returns {"error", "suggestion"}.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
guideNo
topicNo
max_tokensNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.2.0

TDQS

A4.7/5.0
Behavior5/5

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

With no annotations, the description carries the full burden and does so well: it explains why the HTML index cannot be scraped (client-side rendering), that the sitemap fallback lacks titles, that guide pages are server-rendered and therefore retrievable, how `max_tokens` truncation is estimated (len(text)//4), and the exact failure payload shape {"error", "suggestion"}. This is unusually rich disclosure of internal behavior and failure modes.

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?

The two-mode structure is front-loaded and the description is scannable, with each paragraph mapping to one branch of the tool. The aside about client-side rendering versus server-rendered guide pages is longer than strictly necessary, though it does justify result quality, so it is not pure waste.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a three-parameter, no-output-schema tool with zero annotation coverage, the description supplies both modes' return shapes (catalogue fields title/url/type/category/description; markdown for a single guide) plus the error contract. An agent has everything needed to call it correctly and interpret the result.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters5/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0%, so the description must compensate, and it does for all three parameters: `guide` accepts slugs, short forms like "gs/spring-boot", or full spring.io URLs; `topic` filters the catalogue by title/slug/category/description and, in guide mode, narrows to a matching heading section; `max_tokens` truncates with a stated estimation formula.

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 opening sentence states a concrete verb and resource ('List the spring.io guides, or read one guide as markdown') and immediately splits the tool into two clearly delineated modes keyed on the `guide` parameter. It also anchors itself against a sibling by noting the `topic` behavior matches `java_docs(topic=...)`, so an agent can place it in the toolset without opening the schema.

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?

It gives explicit routing rules: omit `guide` for the catalogue, supply `guide` for markdown, and describes what `topic` does in each mode. What's missing is guidance on when to prefer this over other documentation siblings such as `spring_reference` or `spring_search_concepts`, so the alternative-selection story is incomplete.

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