关键词

Spring文档搜索代码示例库迁移规划Java语言演进API文档索引

项目简介

Spring Documentation MCP Server是一个专门为AI助手设计的服务器应用，通过标准化的Model Context Protocol（MCP）向Claude等AI客户端提供Spring框架的完整文档访问能力。它集成了Spring官方文档、GitHub源码文档、代码示例库、迁移配方、语言特性追踪以及公司指南等多种功能。

主要功能

  • 文档搜索：全文检索Spring Boot、Spring Framework等项目的官方文档
  • 代码示例：可搜索的Spring代码片段库，支持多种编程语言
  • 迁移规划：提供Spring版本升级的OpenRewrite迁移配方
  • 语言演进：追踪Java 8+和Kotlin 1.6+的语言特性变化
  • 公司指南：管理企业特定的架构模式、合规规则和AI代理配置
  • Boot Initializr集成：依赖搜索、兼容性检查和格式化代码片段
  • Javadoc API文档：爬取和索引Spring项目的API文档
  • 团队访问控制：通过API密钥实现基于团队的权限管理
  • 实时监控：提供MCP服务器运行状态和工具使用情况的仪表板

安装步骤

环境要求

  • Java 25（LTS版本）必须安装
  • PostgreSQL数据库

快速启动

  1. 启动数据库：

    docker-compose up -d postgres

  2. 构建和运行：

    ./gradlew clean build
java -jar build/libs/spring-boot-documentation-mcp-server-1.5.0.jar

  3. 访问应用：

    • Web管理界面：http://localhost:8080
    • 默认登录：用户名 'admin'，密码 'admin'
    • MCP SSE端点：http://localhost:8080/mcp/spring/sse

服务器配置

MCP客户端需要配置以下信息来连接服务器：

服务器名称：'spring-documentation-server'

启动命令：

{
  "command": "java",
  "args": ["-jar", "spring-boot-documentation-mcp-server-1.5.0.jar

重要配置参数：

  • 服务器端口：8080（可通过环境变量调整）
  • 认证方式：API密钥（在Web界面中生成）
  • 支持SSE（Server-Sent Events）传输协议

基本使用方法

  1. 登录Web管理界面生成API密钥
  2. 在MCP客户端配置文件中添加服务器连接信息
  3. 重启客户端以建立连接

API密钥使用方式：

  • 在请求头中添加：'X-API-Key: smcp_your_key_here
  1. 重启客户端以建立连接

认证配置

MCP客户端需要提供API密钥进行认证，可通过以下任一方式：

  • 请求头：'X-API-Key: smcp_...'
  • 或Bearer令牌：'Authorization: Bearer smcp_...'

功能特性

  • 44个MCP工具：涵盖文档、迁移、语言、指南、初始化等多个领域
  • 实时同步：自动从spring.io和GitHub同步最新文档
  • 全文搜索：基于PostgreSQL的高性能搜索
  • 多租户支持：通过Flavor Groups实现团队级访问控制
  • 高性能缓存：使用Caffeine缓存提升响应速度
  • 安全可靠：BCrypt加密的API密钥和基于角色的访问控制

信息

分类

开发者工具

访问项目