Skip to main content
Glama
tky0065

springdocs-mcp

by tky0065
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Remote

get_spring_reference

Fetch a specific section of Spring reference documentation for Boot, AI, Framework, Security, Data JPA, and more. Use project, version, and subsection options to navigate.

Instructions

Get specific section of Spring reference documentation (supports Spring Boot, Spring AI, Spring Framework, etc.)

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
offsetNoPosition (en caractères) pour lire la suite d'un document tronqué, fournie dans le pied de la réponse précédente
projectNoSpring project to search ('boot' for Spring Boot, 'ai' for Spring AI, 'framework' for Spring Framework, 'security' for Spring Security, 'data-jpa' for Spring Data JPA, 'batch' for Spring Batch, 'integration' for Spring Integration, 'kafka' for Spring for Apache Kafka, 'modulith' for Spring Modulith, 'cloud-gateway' for Spring Cloud Gateway, 'cloud-config' for Spring Cloud Config)boot
sectionYesDocumentation section (e.g., 'web', 'data' for Boot; 'chatclient', 'rag' for AI; 'core', 'web' for Framework)
versionNoVersion de la documentation (ex: '3.4' ou '3.4.2' ; le patch est ignoré). Omis ou 'current' = dernière version. Les anciennes versions peuvent ne pas être publiées.
subsectionNoOptional subsection for more precise navigation

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed6 schema fields changedv1.4.1
    • addedInput schema / properties / offset
      Added value: +{
+  "default": 0,
+  "description": "Position (en caractères) pour lire la suite d'un document tronqué, fournie dans le pied de la réponse précédente",
+  "maximum": 10000000,
+  "minimum": 0,
+  "type": "number"
+}
    • changedInput schema / properties / project / description
      Previous value: -"Spring project to search ('boot' for Spring Boot, 'ai' for Spring AI, 'framework' for Spring Framework)"New value: +"Spring project to search ('boot' for Spring Boot, 'ai' for Spring AI, 'framework' for Spring Framework, 'security' for Spring Security, 'data-jpa' for Spring Data JPA, 'batch' for Spring Batch, 'integration' for Spring Integration, 'kafka' for Spring for Apache Kafka, 'modulith' for Spring Modulith, 'cloud-gateway' for Spring Cloud Gateway, 'cloud-config' for Spring Cloud Config)"
    • changedInput schema / properties / project / enum
      Previous value: -[
-  "boot",
-  "ai",
-  "framework"
-]New value: +[
+  "boot",
+  "ai",
+  "framework",
+  "security",
+  "data-jpa",
+  "batch",
+  "integration",
+  "kafka",
+  "modulith",
+  "cloud-gateway",
+  "cloud-config"
+]
    • addedInput schema / properties / section / maxLength
      Added value: +100
    • addedInput schema / properties / subsection / maxLength
      Added value: +100
    • addedInput schema / properties / version
      Added value: +{
+  "description": "Version de la documentation (ex: '3.4' ou '3.4.2' ; le patch est ignoré). Omis ou 'current' = dernière version. Les anciennes versions peuvent ne pas être publiées.",
+  "maxLength": 20,
+  "type": "string"
+}
  2. First observedv1.2.8

TDQS

C2.9/5.0
Behavior2/5

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

No annotations are provided, so the description carries the full burden of behavioral disclosure. It says nothing about output format, pagination behavior, truncation, or authentication requirements. The `offset` parameter description hints at truncated documents, but that's in the schema, not the description. Significant gap for a tool with zero annotation coverage.

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?

A single efficient sentence with no waste. Front-loaded with the verb and resource. Very concise, though perhaps too brief to be truly helpful.

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

Completeness2/5

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

For a tool with 5 parameters, no annotations, and no output schema, the description is minimal. It doesn't explain return format, pagination, or how to handle truncated responses despite the offset parameter implying truncation. The description should do more to prepare an agent for correct invocation.

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 the schema already documents all parameters thoroughly, including the enum for `project` and the `offset` truncation behavior. The description adds nothing new about parameters. Baseline 3 is appropriate when the schema does all the heavy lifting.

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: 'Get specific section of Spring reference documentation'. It enumerates supported projects, but it does not distinguish itself from siblings like search_spring_docs or get_spring_guide. It's clear but lacks sibling differentiation.

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

Usage Guidelines2/5

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

No when-to-use guidance, no exclusions, no mention of alternatives like search_spring_docs for keyword searching. The description only says what it does, not when to choose it over siblings.

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

Deploy Server

Other Tools