Spring Docs

by tky0065

442 downloads Not rated yet

GitHub Website

Knowledge Base

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…

Explore

- 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

---

- Ecosystem-wide search across projects, guides, docs, and APIs
- Progressive tutorials with beginner/intermediate/advanced levels
- Smart version comparison with detailed migration guidance
- Expert best practices categorized by domain and experience level
- Intelligent diagnostics for common Spring Boot issues

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:

Download and install Highlight from highlightai.com/download
Navigate to the plugins tab and select "Add Custom Plugin"
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.
Enable "Start Automatically" if you want the plugin to start when Highlight launches

Setting up with Cursor

Open Cursor's settings
Navigate to the MCP section
Click "Add new Global MCP server"
Copy and paste the configuration below based on your operating system

JSON

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

JSON

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

JSON

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

Setting up with Claude Desktop

Open Claude Desktop's settings
Go to the Integrations tab
Click "Add MCP Server"
Use the configuration below based on your operating system

Note: Make sure Claude Desktop is running before attempting to connect.

JSON

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

JSON

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

JSON

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

Setting up with Windsurf

Open Windsurf's preferences
Go to the Integrations section
Click "Add MCP Integration"
Use the configuration below based on your operating system

JSON

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

JSON

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

JSON

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

Setting up with Cline

Open Cline's settings
Navigate to the Integrations section
Click "Add MCP Server"
Copy and paste the configuration below based on your operating system

Note: Make sure to restart Cline after adding the configuration.

JSON

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

JSON

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

JSON

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

Setting up with Goose

Open Goose's preferences
Go to the Integrations tab
Select "MCP Servers"
Click "Add New Server"
Use the configuration below based on your operating system

JSON

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

JSON

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

JSON

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

From the repository

``bash npm install -g @enokdev/springdocs-mcp

`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" } } } }`---

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

bash

git clone https://github.com/tky0065/springdocs-mcp.git

cd springdocs-mcp

npm install

npm run build

npm test



for tool in "search_spring_docs" "search_spring_projects" "search_spring_ecosystem"; do

  echo "Testing $tool..."

  echo "{\"jsonrpc\": \"2.0\", \"id\": 1, \"method\": \"tools/call\", \"params\": {\"name\": \"$tool\", \"arguments\": {\"query\": \"test\", \"limit\": 2}}}" | npx @enokdev/springdocs-mcp@latest > /dev/null

done





---
cat ~/Library/Application\ Support/Claude/claude_desktop_config.json | jq .



Solutions:

1. Add database dependency to pom.xml

2. Configure datasource in application.properties

3. Exclude auto-configuration: @SpringBootApplication(exclude = {DataSourceAutoConfiguration.class})
- Issues: https://github.com/tky0065/springdocs-mcp/issues

- Discussions: https://github.com/tky0065/springdocs-mcp/discussions

- NPM Package: https://www.npmjs.com/package/@enokdev/springdocs-mcp
1. Search existing issues on GitHub

2. Create detailed issue with error messages and steps to reproduce

3. Join community discussions for questions and feature requests
git clone https://github.com/tky0065/springdocs-mcp.git

cd springdocs-mcp

npm install

npm run build
claude-code --mcp-server "npx @enokdev/springdocs-mcp@latest"
claude-code --mcp-config claude-mcp-config.json


gemini --mcp-config gemini-config.yaml

export GEMINI_MCP_SERVERS='[{"name":"spring-docs","command":"npx","args":["@enokdev/springdocs-mcp@latest"]}]' gemini "Search for Spring Boot security documentation"``

`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

| 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" |

| 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" |

for tool in "search_spring_docs" "search_spring_projects" "search_spring_ecosystem"; do
echo "Testing $tool..."
echo "{\"jsonrpc\": \"2.0\", \"id\": 1, \"method\": \"tools/call\", \"params\": {\"name\": \"$tool\", \"arguments\": {\"query\": \"test\", \"limit\": 2}}}" | npx @enokdev/springdocs-mcp@latest > /dev/null
done
``---


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

echo '{"jsonrpc": "2.0", "id": 3, "method": "tools/call", "params": {"name": "search_spring_projects", "arguments": {"query": "boot", "limit": 1}}}' | npx @enokdev/springdocs-mcp@latest``

---

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

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

Email sign in

No reviews posted yet.

About

Explore

Setting up with Highlight

From the repository

search_spring_docs

search_spring_projects

get_spring_project

get_all_spring_guides

get_spring_guide

get_spring_reference

search_spring_concepts

search_spring_ecosystem

get_spring_tutorial

compare_spring_versions

get_spring_best_practices

diagnose_spring_issues

Claude Desktop / Cursor

McpServers

Then use: springdocs-mcp

✨ Features & Tools

📚 Core Documentation (7 Enhanced Tools)

🆕 Advanced Tools (5 New)

⚡ Performance Features

📖 Usage Examples

Basic Search

Ecosystem Exploration

Learning Path

Problem Solving

Migration Planning

Best Practices

🔧 Advanced Configuration

Performance Optimization

Corporate/Proxy Environment

🧪 Testing & Development

Quick Test

Development Setup

Load Testing

More like this

Aws Kb Retrieval Server

Memory

Context 7

MaxKB

`search_spring_docs`

`search_spring_projects`

`get_spring_project`

`get_all_spring_guides`

`get_spring_guide`

`get_spring_reference`

`search_spring_concepts`

`search_spring_ecosystem`

`get_spring_tutorial`

`compare_spring_versions`

`get_spring_best_practices`

`diagnose_spring_issues`