Spring Docs

by tky0065

442 downloads
Not rated
GitHub

About

Spring Docs is an MCP server that provides 12 tools for searching, exploring, and interacting with the Spring ecosystem documentation, guides, tutorials, and best practices. It is designed for developers using MCP-compatible clients like Claude Code, Gemini CLI, VS Code, and…

Details

Author
tky0065
Downloads
442
Categories
Knowledge Base

- 12 tools including documentation search, project lookup, guide retrieval, and reference fetching.
- 5 advanced tools: ecosystem search, tutorials, version comparison, best practices, and diagnostics.
- Intelligent caching achieving 85% cache hit rate and 50–80% faster response times.
- Auto-retry logic with exponential backoff for 99.5% reliability.
- Supports parallel processing and multiple data sources.
- Universal compatibility with all MCP-compatible clients.

Setting up with Highlight

This MCP is not yet compatible with Highlight’s one-click setup. However, you can still use it with Highlight by following these steps:

  1. Download and install Highlight from highlightai.com/download
  2. Navigate to the plugins tab and select "Add Custom Plugin"
  3. Configure the plugin with the settings below
    Plugin Name Spring Docs
    Command (node, npx, python, etc.)

    Please refer to the README for specific instructions on how to obtain API keys or other required environment variables.

  4. Enable "Start Automatically" if you want the plugin to start when Highlight launches

From the repository

Install the server via npx (npx @enokdev/springdocs-mcp@latest) or globally (npm install -g @enokdev/springdocs-mcp). Configure it in your MCP client's config file using the command and args shown in the README, then invoke tools by natural language prompts such as "Search for REST API documentation in Spring Boot" or "Diagnose 'Failed to configure DataSource' error".

search_spring_docs

Recherche dans la documentation Spring Boot avec des mots-clés

search_spring_projects

Recherche parmi tous les projets Spring disponibles sur spring.io/projects

get_spring_project

Récupère les détails complets d'un projet Spring spécifique

get_all_spring_guides

Récupère la liste de tous les guides Spring disponibles, optionnellement filtrés par catégorie

get_spring_guide

Récupère le contenu d'un guide Spring Boot spécifique avec niveau de détail configurable

get_spring_reference

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

search_spring_concepts

Recherche des concepts Spring Boot par catégorie avec des explications détaillées

search_spring_ecosystem

Search across the entire Spring ecosystem including all projects, guides, documentation, and Spring AI

get_spring_tutorial

Get step-by-step tutorials for specific Spring Boot features

compare_spring_versions

Compare different Spring Boot versions and their features

get_spring_best_practices

Get best practices and recommendations for Spring Boot development

diagnose_spring_issues

Diagnose common Spring Boot issues and provide solutions

Claude Desktop / Cursor

Paste into your MCP client config file to install this server.

{
    "mcpServers": {
        "spring docs": {
            "spring-docs": {
                "command": "npx",
                "args": [
                    "@enokdev/springdocs-mcp@latest"
                ],
                "description": "Spring Documentation MCP Server with 12 powerful tools"
            }
        }
    }
}

McpServers

{
    "spring-docs": {
        "command": "npx",
        "args": [
            "@enokdev/springdocs-mcp@latest"
        ],
        "description": "Spring Documentation MCP Server with 12 powerful tools"
    }
}

Then use: springdocs-mcp

`` Config file locations: - Claude Desktop: ~/Library/Application Support/Claude/claude_desktop_config.json (macOS) / %APPDATA%\Claude\claude_desktop_config.json (Windows) - Claude Code: ~/.claude-code/mcp-config.json - VS Code: ~/.vscode/mcp-settings.json - JetBrains IDEs: .jetbrains/mcp-config.json ---

✨ Features & Tools

📚 Core Documentation (7 Enhanced Tools)

| Tool | Purpose | Example Usage | |------|---------|---------------| |
search_spring_docs | Search documentation with caching | "Search for REST API security" | | search_spring_projects | Find Spring projects | "Search for microservices projects" | | get_spring_project | Get project details | "Get Spring Boot project info" | | get_all_spring_guides | List available guides | "Show all security guides" | | get_spring_guide | Get complete guide content | "Get gs-rest-service guide" | | get_spring_reference | Reference documentation | "Get web reference docs" | | search_spring_concepts | Explore Spring concepts | "Explain auto-configuration" |

🆕 Advanced Tools (5 New)

| Tool | Purpose | Example Usage | |------|---------|---------------| |
search_spring_ecosystem | Search entire ecosystem | "Find reactive programming resources" | | get_spring_tutorial | Step-by-step tutorials | "Get intermediate REST API tutorial" | | compare_spring_versions | Version comparison & migration | "Compare Spring Boot 2.7 vs 3.0" | | get_spring_best_practices | Expert guidance by category | "Get security best practices" | | diagnose_spring_issues | Intelligent error diagnosis | "Diagnose port 8080 error" |

Performance Features

- 50-80% faster with intelligent caching - 85% cache hit rate for popular queries - Auto-retry logic with exponential backoff - Multiple data sources for reliability - Parallel processing for complex searches ---

📖 Usage Examples

Basic Search

` "Search for REST API documentation in Spring Boot" `

Ecosystem Exploration

` "Search the Spring ecosystem for microservices patterns" `

Learning Path

` "Get a beginner tutorial for REST API development" `

Problem Solving

` "Diagnose 'Failed to configure DataSource' error" `

Migration Planning

` "Compare Spring Boot 2.7.0 and 3.0.0 breaking changes" `

Best Practices

` "Get architecture best practices for expert developers" ` ---

🔧 Advanced Configuration

Performance Optimization

`json { "mcpServers": { "spring-docs": { "command": "npx", "args": ["@enokdev/springdocs-mcp@latest"], "env": { "NODE_OPTIONS": "--max-old-space-size=4096", "REQUEST_TIMEOUT": "15000", "MAX_RETRIES": "3" } } } } `

Corporate/Proxy Environment

`json { "mcpServers": { "spring-docs": { "command": "npx", "args": ["@enokdev/springdocs-mcp@latest"], "env": { "HTTP_PROXY": "http://proxy.company.com:8080", "HTTPS_PROXY": "http://proxy.company.com:8080" } } } } ` ---

🧪 Testing & Development

Quick Test

`bash echo '{"jsonrpc": "2.0", "id": 1, "method": "tools/list", "params": {}}' | npx @enokdev/springdocs-mcp@latest `

Development Setup

`bash git clone https://github.com/tky0065/springdocs-mcp.git cd springdocs-mcp npm install npm run build npm test `

Load Testing

``bash
No reviews yet — be the first

Sign in to leave a review

Use Google, GitHub, or an email account so ratings stay tied to real people.

Email sign in

No reviews posted yet.