@enokdev/springdocs-mcp 1.2.7 → 1.4.1

package/build/resources.js

@@ -0,0 +1,66 @@
+import { ErrorCode, McpError } from "@modelcontextprotocol/sdk/types.js";
+import { springProjectsConfig } from "./services/spring-projects-config.js";
+// MCP resources: the Spring documentation the server already fetches, served as complete markdown documents.
+// Real API only: reads go through the same services, cache and URL checks as the tools.
+const MIME_TYPE = "text/markdown";
+const PROJECT_PATTERN = /^spring:\/\/project\/([a-z0-9][a-z0-9-]*)$/;
+const GUIDE_PATTERN = /^spring:\/\/guide\/([A-Za-z0-9][A-Za-z0-9._-]*)$/;
+const ACCEPTED_FORMS = "spring://project/<name> (e.g. spring://project/spring-boot) or spring://guide/<id> (e.g. spring://guide/rest-service)";
+/** Strict parsing of the raw string: no URL normalization, so nothing but the two accepted forms gets through. */
+export function parseResourceUri(uri) {
+    const project = PROJECT_PATTERN.exec(uri);
+    if (project)
+        return { kind: "project", id: project[1] };
+    const guide = GUIDE_PATTERN.exec(uri);
+    if (guide && !guide[1].includes(".."))
+        return { kind: "guide", id: guide[1] };
+    throw new McpError(ErrorCode.InvalidParams, `Invalid resource URI. Expected ${ACCEPTED_FORMS}`);
+}
+export class ResourcesService {
+    docs;
+    constructor(docs) {
+        this.docs = docs;
+    }
+    listResources() {
+        return springProjectsConfig.getAllProjects().map((project) => ({
+            uri: `spring://project/spring-${project.id}`,
+            name: project.displayName,
+            description: `${project.displayName} project page on spring.io`,
+            mimeType: MIME_TYPE,
+        }));
+    }
+    listTemplates() {
+        return [
+            {
+                uriTemplate: "spring://project/{name}",
+                name: "Spring project",
+                description: "Any project page of spring.io/projects, by slug (e.g. spring-boot)",
+                mimeType: MIME_TYPE,
+            },
+            {
+                uriTemplate: "spring://guide/{id}",
+                name: "Spring guide",
+                description: "A getting-started guide of spring.io/guides, by id (e.g. rest-service)",
+                mimeType: MIME_TYPE,
+            },
+        ];
+    }
+    async readResource(uri) {
+        const { kind, id } = parseResourceUri(uri);
+        try {
+            let text;
+            if (kind === "project") {
+                const { markdown, url } = await this.docs.getProjectMarkdown(id);
+                text = `# ${id}\n\n${markdown}\n\nSource: ${url}`;
+            }
+            else {
+                text = await this.docs.getGuide(id, "full");
+            }
+            return { contents: [{ uri, mimeType: MIME_TYPE, text }] };
+        }
+        catch (error) {
+            throw new McpError(ErrorCode.InternalError, error instanceof Error ? error.message : "Unable to read the resource");
+        }
+    }
+}
+//# sourceMappingURL=resources.js.map

package/build/resources.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"resources.js","sourceRoot":"","sources":["../src/resources.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,oCAAoC,CAAC;AAEzE,OAAO,EAAE,oBAAoB,EAAE,MAAM,sCAAsC,CAAC;AAE5E,6GAA6G;AAC7G,wFAAwF;AAExF,MAAM,SAAS,GAAG,eAAe,CAAC;AAClC,MAAM,eAAe,GAAG,4CAA4C,CAAC;AACrE,MAAM,aAAa,GAAG,kDAAkD,CAAC;AACzE,MAAM,cAAc,GAAG,uHAAuH,CAAC;AAI/I,kHAAkH;AAClH,MAAM,UAAU,gBAAgB,CAAC,GAAW;IAC1C,MAAM,OAAO,GAAG,eAAe,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC1C,IAAI,OAAO;QAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC;IAExD,MAAM,KAAK,GAAG,aAAa,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACtC,IAAI,KAAK,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC;QAAE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;IAE9E,MAAM,IAAI,QAAQ,CAAC,SAAS,CAAC,aAAa,EAAE,kCAAkC,cAAc,EAAE,CAAC,CAAC;AAClG,CAAC;AAED,MAAM,OAAO,gBAAgB;IACP;IAApB,YAAoB,IAAoC;QAApC,SAAI,GAAJ,IAAI,CAAgC;IAAG,CAAC;IAE5D,aAAa;QACX,OAAO,oBAAoB,CAAC,cAAc,EAAE,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;YAC7D,GAAG,EAAE,2BAA2B,OAAO,CAAC,EAAE,EAAE;YAC5C,IAAI,EAAE,OAAO,CAAC,WAAW;YACzB,WAAW,EAAE,GAAG,OAAO,CAAC,WAAW,4BAA4B;YAC/D,QAAQ,EAAE,SAAS;SACpB,CAAC,CAAC,CAAC;IACN,CAAC;IAED,aAAa;QACX,OAAO;YACL;gBACE,WAAW,EAAE,yBAAyB;gBACtC,IAAI,EAAE,gBAAgB;gBACtB,WAAW,EAAE,oEAAoE;gBACjF,QAAQ,EAAE,SAAS;aACpB;YACD;gBACE,WAAW,EAAE,qBAAqB;gBAClC,IAAI,EAAE,cAAc;gBACpB,WAAW,EAAE,wEAAwE;gBACrF,QAAQ,EAAE,SAAS;aACpB;SACF,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,YAAY,CAAC,GAAW;QAC5B,MAAM,EAAE,IAAI,EAAE,EAAE,EAAE,GAAG,gBAAgB,CAAC,GAAG,CAAC,CAAC;QAC3C,IAAI,CAAC;YACH,IAAI,IAAY,CAAC;YACjB,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;gBACvB,MAAM,EAAE,QAAQ,EAAE,GAAG,EAAE,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,kBAAkB,CAAC,EAAE,CAAC,CAAC;gBACjE,IAAI,GAAG,KAAK,EAAE,OAAO,QAAQ,eAAe,GAAG,EAAE,CAAC;YACpD,CAAC;iBAAM,CAAC;gBACN,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC;YAC9C,CAAC;YACD,OAAO,EAAE,QAAQ,EAAE,CAAC,EAAE,GAAG,EAAE,QAAQ,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC;QAC5D,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,IAAI,QAAQ,CAAC,SAAS,CAAC,aAAa,EAAE,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,6BAA6B,CAAC,CAAC;QACtH,CAAC;IACH,CAAC;CACF"}

package/build/services/advanced-features.d.ts

@@ -1,24 +1,29 @@
+import { CacheService } from './cache.js';
+import { SpringProjectsConfig } from './spring-projects-config.js';
+import { ReleaseFocus } from './release-notes.js';
 /**
  * Advanced features service for Spring documentation - uses ONLY real Spring documentation APIs
  * No mock data - everything is fetched from actual Spring documentation sources
  */
 export declare class AdvancedFeaturesService {
     private cache;
-    private turndownService;
     private readonly baseUrl;
     private readonly springProjectsUrl;
-    private readonly springGuideUrl;
-    private readonly REQUEST_TIMEOUT;
-    private readonly MAX_RETRIES;
-    constructor();
+    private projectsConfig;
+    constructor(cache?: CacheService, projectsConfig?: SpringProjectsConfig);
     /**
-     * Search across the entire Spring ecosystem using real APIs
+     * Get the GitHub release notes of a Spring project (a given version or the latest one),
+     * optionally filtered on breaking changes, new features or deprecations.
      */
-    searchEcosystem(query: string, scope?: string, limit?: number): Promise<any>;
+    getReleaseNotes(project: string, version?: string, focus?: ReleaseFocus): Promise<string>;
+    /** Throws a clear error when GitHub refused the request because of its rate limit. */
+    private assertNotRateLimited;
+    /** Latest stable release of an "X.Y" minor, paginating the GitHub releases list. */
+    private findLatestOfMinor;
     /**
-     * Extract content intelligently - same as in SpringBootDocsServiceOptimized
+     * Search across the entire Spring ecosystem using real APIs
      */
-    private extractIntelligentContent;
+    searchEcosystem(query: string, scope?: string, limit?: number): Promise<any>;
     /**
      * Get tutorials by fetching from actual Spring Boot guides
      */
@@ -38,6 +43,11 @@ export declare class AdvancedFeaturesService {
     private searchProjects;
     private searchGuides;
     private searchDocumentation;
+    /**
+     * Search Spring AI documentation and resources
+     * Covers ChatClient, RAG, embeddings, vector stores, and LLM integrations
+     */
+    private searchSpringAI;
     private searchAPI;
     private formatEcosystemResults;
     private fetchWithRetry;

package/build/services/advanced-features.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"advanced-features.d.ts","sourceRoot":"","sources":["../../src/services/advanced-features.ts"],"names":[],"mappings":"AAKA;;;GAGG;AACH,qBAAa,uBAAuB;IAClC,OAAO,CAAC,KAAK,CAAe;IAC5B,OAAO,CAAC,eAAe,CAAkB;IACzC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAA4B;IACpD,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAgC;IAClE,OAAO,CAAC,QAAQ,CAAC,cAAc,CAA8B;IAC7D,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAS;IACzC,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAK;;IAUjC;;OAEG;IACG,eAAe,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,GAAE,MAAc,EAAE,KAAK,GAAE,MAAU;IAyC7E;;OAEG;IACH,OAAO,CAAC,yBAAyB;IAqDjC;;OAEG;IACG,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,GAAE,MAAmB,EAAE,WAAW,GAAE,MAAiB;IAyC3F;;OAEG;IACG,eAAe,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAK,GAAE,MAAc;IAqD/E;;OAEG;IACG,gBAAgB,CAAC,QAAQ,EAAE,MAAM,EAAE,eAAe,GAAE,MAAuB;IA4DjF;;OAEG;IACG,cAAc,CAAC,YAAY,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM;YAiDpE,cAAc;YAkCd,YAAY;YAmCZ,mBAAmB;YA+BnB,SAAS;IAkBvB,OAAO,CAAC,sBAAsB;YA+ChB,cAAc;CA0B7B"}
+{"version":3,"file":"advanced-features.d.ts","sourceRoot":"","sources":["../../src/services/advanced-features.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAK1C,OAAO,EAAE,oBAAoB,EAAwB,MAAM,6BAA6B,CAAC;AAEzF,OAAO,EAAE,YAAY,EAAmF,MAAM,oBAAoB,CAAC;AAYnI;;;GAGG;AACH,qBAAa,uBAAuB;IAClC,OAAO,CAAC,KAAK,CAAe;IAC5B,OAAO,CAAC,QAAQ,CAAC,OAAO,CAA4B;IACpD,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAgC;IAElE,OAAO,CAAC,cAAc,CAAuB;gBAG3C,KAAK,GAAE,YAAiC,EACxC,cAAc,GAAE,oBAA2C;IAM7D;;;OAGG;IACG,eAAe,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,EAAE,KAAK,GAAE,YAAoB,GAAG,OAAO,CAAC,MAAM,CAAC;IA+EtG,sFAAsF;IACtF,OAAO,CAAC,oBAAoB;IAM5B,oFAAoF;YACtE,iBAAiB;IAuB/B;;OAEG;IACG,eAAe,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,GAAE,MAAc,EAAE,KAAK,GAAE,MAAU;IAuD7E;;OAEG;IACG,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,GAAE,MAAmB,EAAE,WAAW,GAAE,MAAiB;IAwC3F;;OAEG;IACG,eAAe,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAK,GAAE,MAAc;IA2E/E;;OAEG;IACG,gBAAgB,CAAC,QAAQ,EAAE,MAAM,EAAE,eAAe,GAAE,MAAuB;IA4DjF;;OAEG;IACG,cAAc,CAAC,YAAY,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM;YAOpE,cAAc;YAgCd,YAAY;YAiBZ,mBAAmB;IA+BjC;;;OAGG;YACW,cAAc;YAsDd,SAAS;IAmBvB,OAAO,CAAC,sBAAsB;IA4D9B,OAAO,CAAC,cAAc;CAGvB"}