@atlaskit/ads-mcp 0.13.9 → 0.15.0

package/dist/es2019/tools/get-lint-rules/index.js

@@ -0,0 +1,97 @@
+import Fuse from 'fuse.js';
+import { z } from 'zod';
+import { cleanQuery, zodToJsonSchema } from '../../helpers';
+import { lintRulesStructuredContent } from './lint-rules-structured-content.codegen';
+export const getLintRulesInputSchema = z.object({
+  terms: z.array(z.string()).default([]).describe('An array of search terms to find lint rules by name or description, eg. `["icon-label", "xcss", "design token"]`. If empty or not provided, returns all lint rules.').optional(),
+  limit: z.number().default(1).describe('Maximum number of results per search term in the array (default: 1)').optional(),
+  exactName: z.boolean().default(false).describe('Enable to explicitly search lint rules by the exact rule name match (when you know the rule name, but need more details)').optional()
+});
+export const listGetLintRulesTool = {
+  name: 'ads_get_lint_rules',
+  description: `Get Atlassian Design System ESLint rule documentation (constellation) with optional search functionality.
+
+- If search parameters are provided, searches for lint rules matching the criteria.
+- If no search parameters are provided, returns all lint rules.
+
+Example: use this tool to look up documentation for rules like icon-label, ensure-proper-xcss-usage, or no-deprecated-apis.`,
+  annotations: {
+    title: 'Get ADS lint rules',
+    readOnlyHint: true,
+    destructiveHint: false,
+    idempotentHint: true,
+    openWorldHint: true
+  },
+  inputSchema: zodToJsonSchema(getLintRulesInputSchema)
+};
+export const getLintRulesTool = async params => {
+  const {
+    terms = [],
+    limit = 1,
+    exactName = false
+  } = params;
+  const searchTerms = terms.filter(Boolean).map(cleanQuery);
+  const ruleDocs = lintRulesStructuredContent;
+
+  // If no search terms provided, return all rules formatted as Markdown
+  if (searchTerms.length === 0) {
+    const allRulesMarkdown = ruleDocs.map(rule => rule.content).join('\n\n');
+    return {
+      content: [{
+        type: 'text',
+        text: allRulesMarkdown
+      }]
+    };
+  }
+
+  // Search logic (similar to get-icons / get-tokens)
+  if (exactName) {
+    const exactNameMatches = searchTerms.map(term => {
+      return ruleDocs.find(rule => rule.ruleName.toLowerCase() === term.toLowerCase());
+    }).filter(rule => rule !== undefined);
+    const formattedRules = exactNameMatches.map(rule => rule.content).join('\n\n');
+    return {
+      content: [{
+        type: 'text',
+        text: formattedRules
+      }]
+    };
+  }
+
+  // use Fuse.js to fuzzy-search for the rules
+  const fuse = new Fuse(ruleDocs, {
+    keys: [{
+      name: 'ruleName',
+      weight: 3
+    }, {
+      name: 'description',
+      weight: 2
+    }, {
+      name: 'content',
+      weight: 1
+    }],
+    threshold: 0.4
+  });
+  const results = searchTerms.map(term => {
+    const exactNameMatch = ruleDocs.find(rule => rule.ruleName.toLowerCase() === term.toLowerCase());
+    if (exactNameMatch) {
+      return [{
+        item: exactNameMatch
+      }];
+    }
+    return fuse.search(term).slice(0, limit);
+  }).flat();
+
+  // Remove duplicates based on ruleName
+  const uniqueResults = results.filter((result, index, arr) => {
+    return arr.findIndex(r => r.item.ruleName === result.item.ruleName) === index;
+  });
+  const matchedRules = uniqueResults.map(result => result.item);
+  const formattedRules = matchedRules.map(rule => rule.content).join('\n\n');
+  return {
+    content: [{
+      type: 'text',
+      text: formattedRules
+    }]
+  };
+};