@iress-oss/ids-mcp-server 0.0.1 → 5.14.2

package/generated/docs/versions-docs.md

@@ -0,0 +1,17 @@
+[](#versions)Versions
+=====================
+
+Version 5 is the latest release of the library and recommended for new development.
+
+[](#list)List
+-------------
+
+| Version | Links |
+| --- | --- |
+| v5 | [Documentation](https://design.wm.iress.com) |
+| v4 | [Documentation](https://archive.design.aws-wmcore-production-au.iress.online/index.html) |
+| OneUI | No longer available |
+
+On this page
+
+*   [List](#list)

package/package.json

@@ -1,11 +1,14 @@
 {
   "name": "@iress-oss/ids-mcp-server",
-  "version": "0.0.1",
+  "version": "5.14.2",
   "description": "Model Context Protocol (MCP) server for Iress Design System (IDS) component library - provides AI assistants with contextual information about IDS components, design tokens, and usage patterns",
   "type": "module",
-  "main": "./build/index.js",
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/"
+  },
+  "main": "./dist/index.js",
   "bin": {
-    "ids": "build/index.js"
+    "ids": "dist/index.js"
   },
   "packageManager": "yarn@4.4.1",
   "keywords": [
@@ -18,28 +21,34 @@
     "react",
     "ai-assistant"
   ],
-  "homepage": "https://github.com/iress/ids-mcp-server#readme",
+  "homepage": "https://github.com/iress-oss/ids-mcp-server#readme",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/iress/ids-mcp-server.git"
+    "url": "git+https://github.com/iress-oss/ids-mcp-server.git"
   },
   "bugs": {
-    "url": "https://github.com/iress/ids-mcp-server/issues"
+    "url": "https://github.com/iress-oss/ids-mcp-server/issues"
   },
   "author": "Iress",
   "license": "Apache-2.0",
   "scripts": {
-    "build": "tsc && chmod 755 ./build/index.js",
+    "build": "tsc && chmod 755 ./dist/index.js",
+    "clean": "rimraf dist coverage generated .nyc_output",
     "dev": "tsc --watch",
-    "start": "node build/index.js",
-    "test": "echo 'Testing MCP server...' && echo '{\"jsonrpc\":\"2.0\",\"id\":1,\"method\":\"tools/list\"}' | node build/index.js",
-    "test-dev": "chmod +x test-dev-server.sh && ./test-dev-server.sh"
+    "generate": "tsx scripts/generate.ts",
+    "lint": "eslint . --ext ts,tsx,mdx --report-unused-disable-directives --max-warnings 0",
+    "lint:fix": "eslint . --fix",
+    "start": "node dist/index.js",
+    "test": "vitest run --coverage",
+    "test:dev": "chmod +x ./scripts/test-dev-server.sh && ./scripts/test-dev-server.sh",
+    "test:watch": "vitest watch",
+    "typecheck": "tsc --noEmit"
   },
   "files": [
-    "build",
-    "docs",
+    "dist",
+    "generated/docs",
     "README.md",
-    "LICENSE"
+    "LICENSE.txt"
   ],
   "dependencies": {
     "@modelcontextprotocol/sdk": "^1.12.0",
@@ -47,6 +56,25 @@
   },
   "devDependencies": {
     "@types/node": "^22.15.21",
-    "typescript": "^5.8.3"
+    "@types/turndown": "^5.0.5",
+    "@typescript-eslint/eslint-plugin": "^8.0.0",
+    "@typescript-eslint/parser": "~8.34.0",
+    "@vitest/coverage-v8": "^3.2.4",
+    "commander": "^12.0.0",
+    "dotenv": "^16.5.0",
+    "eslint": "^8.56.0",
+    "eslint-config-prettier": "^10.0.0",
+    "eslint-plugin-file-progress": "^1.4.0",
+    "eslint-plugin-prettier": "^5.1.3",
+    "eslint-plugin-sonarjs": "^3.0.0",
+    "playwright": "^1",
+    "prettier": "^3.3.3",
+    "prettier-plugin-sh": "^0.17.0",
+    "rimraf": "^6.0.1",
+    "tsx": "^4.20.3",
+    "turndown": "^7.1.3",
+    "turndown-plugin-gfm": "^1.0.2",
+    "typescript": "^5.8.3",
+    "vitest": "^3.2.4"
   }
 }

package/LICENSE

@@ -1,193 +0,0 @@
-Apache License
-Version 2.0, January 2004
-http://www.apache.org/licenses/
-
-TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
-
-1. Definitions.
-
-   "License" shall mean the terms and conditions for use, reproduction,
-   and distribution as defined by Sections 1 through 9 of this document.
-
-   "Licensor" shall mean the copyright owner or entity granting the License.
-
-   "Legal Entity" shall mean the union of the acting entity and all
-   other entities that control, are controlled by, or are under common
-   control with that entity. For the purposes of this definition,
-   "control" means (i) the power, direct or indirect, to cause the
-   direction or management of such entity, whether by contract or
-   otherwise, or (ii) ownership of fifty percent (50%) or more of the
-   outstanding shares, or (iii) beneficial ownership of such entity.
-
-   "You" (or "Your") shall mean an individual or Legal Entity
-   exercising permissions granted by this License.
-
-   "Source" form shall mean the preferred form for making modifications,
-   including but not limited to software source code, documentation
-   source, and configuration files.
-
-   "Object" form shall mean any form resulting from mechanical
-   transformation or translation of a Source form, including but
-   not limited to compiled object code, generated documentation,
-   and conversions to other media types.
-
-   "Work" shall mean the work of authorship, whether in Source or
-   Object form, made available under the License, as indicated by a
-   copyright notice that is included in or attached to the work
-   (which shall not include in the License file).
-
-   "Derivative Works" shall mean any work, whether in Source or Object
-   form, that is based upon (or derived from) the Work and for which the
-   editorial revisions, annotations, elaborations, or other modifications
-   represent, as a whole, an original work of authorship. For the purposes
-   of this License, Derivative Works shall not include works that remain
-   separable from, or merely link (or bind by name) to the interfaces of,
-   the Work and derivative works thereof.
-
-   "Contribution" shall mean any work of authorship, including
-   the original version of the Work and any modifications or additions
-   to that Work or Derivative Works thereof, that is intentionally
-   submitted to Licensor for inclusion in the Work by the copyright owner
-   or by an individual or Legal Entity authorized to submit on behalf of
-   the copyright owner. For the purposes of this definition, "submitted"
-   means any form of electronic, verbal, or written communication sent
-   to the Licensor or its representatives, including but not limited to
-   communication on electronic mailing lists, source code control
-   systems, and issue tracking systems that are managed by, or on behalf
-   of, the Licensor for the purpose of discussing and improving the Work,
-   but excluding communication that is conspicuously marked or otherwise
-   designated in writing by the copyright owner as "Not a Contribution."
-
-   "Contributor" shall mean Licensor and any individual or Legal Entity
-   on behalf of whom a Contribution has been received by Licensor and
-   subsequently incorporated within the Work.
-
-2. Grant of Copyright License. Subject to the terms and conditions of
-   this License, each Contributor hereby grants to You a perpetual,
-   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-   copyright license to use, reproduce, modify, merge, publish,
-   distribute, sublicense, and/or sell copies of the Work, and to
-   permit persons to whom the Work is furnished to do so, subject to
-   the following conditions:
-
-   The above copyright notice and this permission notice shall be
-   included in all copies or substantial portions of the Work.
-
-3. Grant of Patent License. Subject to the terms and conditions of
-   this License, each Contributor hereby grants to You a perpetual,
-   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-   (except as stated in this section) patent license to make, have made,
-   use, offer to sell, sell, import, and otherwise transfer the Work,
-   where such license applies only to those patent claims licensable
-   by such Contributor that are necessarily infringed by their
-   Contribution(s) alone or by combination of their Contribution(s)
-   with the Work to which such Contribution(s) was submitted. If You
-   institute patent litigation against any entity (including a
-   cross-claim or counterclaim in a lawsuit) alleging that the Work
-   or a Contribution incorporated within the Work constitutes direct
-   or contributory patent infringement, then any patent licenses
-   granted to You under this License for that Work shall terminate
-   as of the date such litigation is filed.
-
-4. Redistribution. You may reproduce and distribute copies of the
-   Work or Derivative Works thereof in any medium, with or without
-   modifications, and in Source or Object form, provided that You
-   meet the following conditions:
-
-   (a) You must give any other recipients of the Work or
-       Derivative Works a copy of this License; and
-
-   (b) You must cause any modified files to carry prominent notices
-       stating that You changed the files; and
-
-   (c) You must retain, in the Source form of any Derivative Works
-       that You distribute, all copyright, patent, trademark, and
-       attribution notices from the Source form of the Work,
-       excluding those notices that do not pertain to any part of
-       the Derivative Works; and
-
-   (d) If the Work includes a "NOTICE" text file as part of its
-       distribution, then any Derivative Works that You distribute must
-       include a readable copy of the attribution notices contained
-       within such NOTICE file, excluding those notices that do not
-       pertain to any part of the Derivative Works, in at least one
-       of the following places: within a NOTICE text file distributed
-       as part of the Derivative Works; within the Source form or
-       documentation, if provided along with the Derivative Works; or,
-       within a display generated by the Derivative Works, if and
-       wherever such third-party notices normally appear. The contents
-       of the NOTICE file are for informational purposes only and
-       do not modify the License. You may add Your own attribution
-       notices within Derivative Works that You distribute, alongside
-       or as an addendum to the NOTICE text from the Work, provided
-       that such additional attribution notices cannot be construed
-       as modifying the License.
-
-   You may add Your own copyright notice to Your modifications and
-   may provide additional or different license terms and conditions
-   for use, reproduction, or distribution of Your modifications, or
-   for any such Derivative Works as a whole, provided Your use,
-   reproduction, and distribution of the Work otherwise complies with
-   the conditions stated in this License.
-
-5. Submission of Contributions. Unless You explicitly state otherwise,
-   any Contribution intentionally submitted for inclusion in the Work
-   by You to the Licensor shall be under the terms and conditions of
-   this License, without any additional terms or conditions.
-   Notwithstanding the above, nothing herein shall supersede or modify
-   the terms of any separate license agreement you may have executed
-   with Licensor regarding such Contributions.
-
-6. Trademarks. This License does not grant permission to use the trade
-   names, trademarks, service marks, or product names of the Licensor,
-   except as required for reasonable and customary use in describing the
-   origin of the Work and reproducing the content of the NOTICE file.
-
-7. Disclaimer of Warranty. Unless required by applicable law or
-   agreed to in writing, Licensor provides the Work (and each
-   Contributor provides its Contributions) on an "AS IS" BASIS,
-   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
-   implied, including, without limitation, any warranties or conditions
-   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
-   PARTICULAR PURPOSE. You are solely responsible for determining the
-   appropriateness of using or redistributing the Work and assume any
-   risks associated with Your exercise of permissions under this License.
-
-8. Limitation of Liability. In no event and under no legal theory,
-   whether in tort (including negligence), contract, or otherwise,
-   unless required by applicable law (such as deliberate and grossly
-   negligent acts) or agreed to in writing, shall any Contributor be
-   liable to You for damages, including any direct, indirect, special,
-   incidental, or consequential damages of any character arising as a
-   result of this License or out of the use or inability to use the
-   Work (including but not limited to damages for loss of goodwill,
-   work stoppage, computer failure or malfunction, or any and all
-   other commercial damages or losses), even if such Contributor
-   has been advised of the possibility of such damages.
-
-9. Accepting Warranty or Additional Liability. When redistributing
-   the Work or Derivative Works thereof, You may choose to offer,
-   and charge a fee for, acceptance of support, warranty, indemnity,
-   or other liability obligations and/or rights consistent with this
-   License. However, in accepting such obligations, You may act only
-   on Your own behalf and on Your sole responsibility, not on behalf
-   of any other Contributor, and only if You agree to indemnify,
-   defend, and hold each Contributor harmless for any liability
-   incurred by, or claims asserted against, such Contributor by reason
-   of your accepting any such warranty or additional liability.
-
-END OF TERMS AND CONDITIONS
-
-Copyright 2025 Iress
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-    http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.

package/build/componentHandlers.js

@@ -1,205 +0,0 @@
-/**
- * Tool handlers for component-related operations
- */
-import { z } from "zod";
-import * as path from "path";
-import { getMarkdownFiles, mapIressComponentToFile, extractIressComponents, readFileContent, } from "./utils.js";
-import { DOCS_DIR } from "./config.js";
-export function handleFindComponent(args) {
-    const schema = z.object({
-        query: z.string(),
-        category: z.enum(["components", "foundations", "resources"]).optional(),
-    });
-    const { query, category } = schema.parse(args);
-    // Check if query is an Iress component name
-    if (query.startsWith("Iress")) {
-        const componentFile = mapIressComponentToFile(query);
-        if (componentFile) {
-            return {
-                content: [
-                    {
-                        type: "text",
-                        text: `Found exact match for **${query}**:\n\n**${componentFile}**\n   ${query} component documentation\n\n*Use \`get_iress_component_info\` with "${query}" for detailed information.*`,
-                    },
-                ],
-            };
-        }
-    }
-    const markdownFiles = getMarkdownFiles();
-    // Filter files by category if specified
-    const filteredFiles = category
-        ? markdownFiles.filter((file) => file.startsWith(`${category}-`))
-        : markdownFiles;
-    const results = [];
-    for (const file of filteredFiles) {
-        try {
-            const filePath = path.join(DOCS_DIR, file);
-            const content = readFileContent(filePath);
-            const lines = content.split("\n");
-            // Score relevance based on query matches in titles and content
-            let relevanceScore = 0;
-            const queryLower = query.toLowerCase();
-            const filenameLower = file.toLowerCase();
-            // Check for Iress component mentions in content
-            const iressComponents = extractIressComponents(content);
-            const hasMatchingIressComponent = iressComponents.some((comp) => comp.toLowerCase().includes(queryLower) ||
-                queryLower.includes(comp.toLowerCase().replace("iress", "")));
-            if (hasMatchingIressComponent) {
-                relevanceScore += 75;
-            }
-            // High relevance for filename matches
-            if (filenameLower.includes(queryLower)) {
-                relevanceScore += 100;
-            }
-            // Medium relevance for title matches
-            const title = lines.find((line) => line.startsWith("#"))?.replace(/^#+\s*/, "") || "";
-            if (title.toLowerCase().includes(queryLower)) {
-                relevanceScore += 50;
-            }
-            // Lower relevance for content matches
-            const contentMatches = content.toLowerCase().split(queryLower).length - 1;
-            relevanceScore += contentMatches * 2;
-            if (relevanceScore > 0) {
-                const componentName = file
-                    .replace(/^components-/, "")
-                    .replace("-docs.md", "");
-                const description = lines
-                    .slice(0, 10)
-                    .find((line) => line.trim() && !line.startsWith("#") && !line.startsWith("<!--"))
-                    ?.trim() || "IDS component documentation";
-                results.push({
-                    file,
-                    relevance: relevanceScore,
-                    description: `${componentName}: ${description}`,
-                });
-            }
-        }
-        catch (error) {
-            console.error(`Error reading file ${file}:`, error);
-        }
-    }
-    // Sort by relevance
-    results.sort((a, b) => b.relevance - a.relevance);
-    return {
-        content: [
-            {
-                type: "text",
-                text: results.length > 0
-                    ? `Found ${results.length} relevant IDS components:\n\n${results
-                        .slice(0, 10) // Limit to top 10 results
-                        .map((r, index) => `${index + 1}. **${r.file}**\n   ${r.description}`)
-                        .join("\n\n")}`
-                    : `No IDS components found matching "${query}". Try searching for common component names like "button", "input", "table", or "modal".`,
-            },
-        ],
-    };
-}
-export function handleGetComponentProps(args) {
-    const schema = z.object({
-        component: z.string(),
-    });
-    const { component } = schema.parse(args);
-    const markdownFiles = getMarkdownFiles();
-    // Find the component file
-    const componentFile = markdownFiles.find((file) => file.includes(`components-${component.toLowerCase()}`) ||
-        file.toLowerCase().includes(component.toLowerCase()));
-    if (!componentFile) {
-        return {
-            content: [
-                {
-                    type: "text",
-                    text: `Component "${component}" not found. Available components:\n${markdownFiles
-                        .filter((f) => f.startsWith("components-"))
-                        .map((f) => `- ${f.replace("components-", "").replace("-docs.md", "")}`)
-                        .join("\n")}`,
-                },
-            ],
-        };
-    }
-    try {
-        const filePath = path.join(DOCS_DIR, componentFile);
-        const content = readFileContent(filePath);
-        // Extract prop information, modes, examples
-        const lines = content.split("\n");
-        const propSections = [];
-        let inPropsSection = false;
-        let currentSection = "";
-        for (const line of lines) {
-            if (line.includes("mode") ||
-                line.includes("prop") ||
-                line.includes("Properties") ||
-                line.includes("API") ||
-                line.includes("Examples")) {
-                if (currentSection) {
-                    propSections.push(currentSection);
-                }
-                currentSection = line + "\n";
-                inPropsSection = true;
-            }
-            else if (inPropsSection && line.trim()) {
-                currentSection += line + "\n";
-            }
-            else if (inPropsSection && !line.trim()) {
-                if (currentSection) {
-                    propSections.push(currentSection);
-                    currentSection = "";
-                }
-                inPropsSection = false;
-            }
-        }
-        if (currentSection) {
-            propSections.push(currentSection);
-        }
-        return {
-            content: [
-                {
-                    type: "text",
-                    text: `**${component} Component Props & API**\n\n${propSections.length > 0
-                        ? propSections.join("\n---\n\n")
-                        : `Props information extracted from ${componentFile}:\n\n${content.slice(0, 2000)}...`}`,
-                },
-            ],
-        };
-    }
-    catch (error) {
-        throw new Error(`Failed to read component file ${componentFile}: ${error}`);
-    }
-}
-export function handleListComponents(args) {
-    const schema = z.object({
-        category: z
-            .enum(["components", "foundations", "resources", "all"])
-            .default("all"),
-    });
-    const { category } = schema.parse(args);
-    const markdownFiles = getMarkdownFiles();
-    const categorized = {
-        components: markdownFiles
-            .filter((f) => f.startsWith("components-"))
-            .map((f) => f.replace("components-", "").replace("-docs.md", "")),
-        foundations: markdownFiles
-            .filter((f) => f.startsWith("foundations-"))
-            .map((f) => f.replace("foundations-", "").replace("-docs.md", "")),
-        resources: markdownFiles
-            .filter((f) => f.startsWith("resources-"))
-            .map((f) => f.replace("resources-", "").replace("-docs.md", "")),
-    };
-    let output = "**IDS Component Library**\n\n";
-    if (category === "all") {
-        output += `**Components (${categorized.components.length})**\n${categorized.components.map((c) => `- ${c}`).join("\n")}\n\n`;
-        output += `**Foundations (${categorized.foundations.length})**\n${categorized.foundations.map((c) => `- ${c}`).join("\n")}\n\n`;
-        output += `**Resources (${categorized.resources.length})**\n${categorized.resources.map((c) => `- ${c}`).join("\n")}`;
-    }
-    else {
-        const items = categorized[category];
-        output += `**${category.charAt(0).toUpperCase() + category.slice(1)} (${items.length})**\n${items.map((c) => `- ${c}`).join("\n")}`;
-    }
-    return {
-        content: [
-            {
-                type: "text",
-                text: output,
-            },
-        ],
-    };
-}

package/build/index.js

@@ -1,51 +0,0 @@
-#!/usr/bin/env node
-import { Server } from "@modelcontextprotocol/sdk/server/index.js";
-import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js";
-import { CallToolRequestSchema, ListResourcesRequestSchema, ListToolsRequestSchema, ReadResourceRequestSchema, } from "@modelcontextprotocol/sdk/types.js";
-import { SERVER_CONFIG, CAPABILITIES } from "./config.js";
-import { toolDefinitions } from "./tools.js";
-import { handleToolCall } from "./toolHandler.js";
-import { handleListResources, handleReadResource } from "./resourceHandlers.js";
-/**
- * Create MCP server for Iress Design System (IDS) component library context
- */
-const server = new Server(SERVER_CONFIG, { capabilities: CAPABILITIES });
-/**
- * List available IDS component documentation resources
- */
-server.setRequestHandler(ListResourcesRequestSchema, async () => {
-    return handleListResources();
-});
-/**
- * Read content from a specific markdown file
- */
-server.setRequestHandler(ReadResourceRequestSchema, async (request) => {
-    return handleReadResource(request);
-});
-/**
- * List available IDS development tools
- */
-server.setRequestHandler(ListToolsRequestSchema, async () => {
-    return {
-        tools: toolDefinitions,
-    };
-});
-/**
- * Handle IDS component library tool calls
- */
-server.setRequestHandler(CallToolRequestSchema, async (request) => {
-    const result = handleToolCall(request);
-    return result;
-});
-/**
- * Start the server
- */
-async function main() {
-    const transport = new StdioServerTransport();
-    await server.connect(transport);
-    console.error("IDS Component Library MCP Server running on stdio");
-}
-main().catch((error) => {
-    console.error("Server error:", error);
-    process.exit(1);
-});