@atlaskit/ads-mcp 1.2.1 → 1.3.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +18 -0
- package/README.md +65 -16
- package/dist/cjs/instructions.js +1 -1
- package/dist/cjs/tools/get-all-components/list-get-all-components-tool.js +1 -1
- package/dist/cjs/tools/get-atlaskit-components/atlaskit-components.codegen.js +1694 -41
- package/dist/cjs/tools/get-atlaskit-components/list-get-atlaskit-components-tool.js +1 -1
- package/dist/cjs/tools/get-atlaskit-hooks/list-get-atlaskit-hooks-tool.js +1 -1
- package/dist/cjs/tools/get-atlaskit-utilities/list-get-atlaskit-utilities-tool.js +1 -1
- package/dist/cjs/tools/get-lint-rules/lint-rules-structured-content.codegen.js +4 -4
- package/dist/cjs/tools/plan/list-plan-tool.js +1 -1
- package/dist/cjs/tools/plan/plan-input-schema.js +3 -3
- package/dist/cjs/tools/plan/plan-tool.js +1 -1
- package/dist/cjs/tools/search-atlaskit-components/list-search-atlaskit-components-tool.js +1 -1
- package/dist/cjs/tools/search-atlaskit-hooks/list-search-atlaskit-hooks-tool.js +1 -1
- package/dist/cjs/tools/search-atlaskit-utilities/list-search-atlaskit-utilities-tool.js +1 -1
- package/dist/cjs/tools/search-components/list-search-components-tool.js +1 -1
- package/dist/cjs/tools/search-components/search-components-tool.js +1 -1
- package/dist/es2019/instructions.js +2 -0
- package/dist/es2019/tools/get-all-components/list-get-all-components-tool.js +1 -1
- package/dist/es2019/tools/get-atlaskit-components/atlaskit-components.codegen.js +1694 -41
- package/dist/es2019/tools/get-atlaskit-components/list-get-atlaskit-components-tool.js +2 -2
- package/dist/es2019/tools/get-atlaskit-hooks/list-get-atlaskit-hooks-tool.js +2 -2
- package/dist/es2019/tools/get-atlaskit-utilities/list-get-atlaskit-utilities-tool.js +2 -2
- package/dist/es2019/tools/get-lint-rules/lint-rules-structured-content.codegen.js +4 -4
- package/dist/es2019/tools/plan/list-plan-tool.js +6 -3
- package/dist/es2019/tools/plan/plan-input-schema.js +3 -3
- package/dist/es2019/tools/plan/plan-tool.js +1 -1
- package/dist/es2019/tools/search-atlaskit-components/list-search-atlaskit-components-tool.js +2 -2
- package/dist/es2019/tools/search-atlaskit-hooks/list-search-atlaskit-hooks-tool.js +2 -2
- package/dist/es2019/tools/search-atlaskit-utilities/list-search-atlaskit-utilities-tool.js +2 -2
- package/dist/es2019/tools/search-components/list-search-components-tool.js +3 -1
- package/dist/es2019/tools/search-components/search-components-tool.js +1 -1
- package/dist/esm/instructions.js +1 -1
- package/dist/esm/tools/get-all-components/list-get-all-components-tool.js +1 -1
- package/dist/esm/tools/get-atlaskit-components/atlaskit-components.codegen.js +1694 -41
- package/dist/esm/tools/get-atlaskit-components/list-get-atlaskit-components-tool.js +1 -1
- package/dist/esm/tools/get-atlaskit-hooks/list-get-atlaskit-hooks-tool.js +1 -1
- package/dist/esm/tools/get-atlaskit-utilities/list-get-atlaskit-utilities-tool.js +1 -1
- package/dist/esm/tools/get-lint-rules/lint-rules-structured-content.codegen.js +4 -4
- package/dist/esm/tools/plan/list-plan-tool.js +1 -1
- package/dist/esm/tools/plan/plan-input-schema.js +3 -3
- package/dist/esm/tools/plan/plan-tool.js +1 -1
- package/dist/esm/tools/search-atlaskit-components/list-search-atlaskit-components-tool.js +1 -1
- package/dist/esm/tools/search-atlaskit-hooks/list-search-atlaskit-hooks-tool.js +1 -1
- package/dist/esm/tools/search-atlaskit-utilities/list-search-atlaskit-utilities-tool.js +1 -1
- package/dist/esm/tools/search-components/list-search-components-tool.js +1 -1
- package/dist/esm/tools/search-components/search-components-tool.js +1 -1
- package/dist/types/instructions.d.ts +1 -1
- package/dist/types/tools/get-atlaskit-components/atlaskit-components.codegen.d.ts +2 -2
- package/dist/types/tools/get-lint-rules/lint-rules-structured-content.codegen.d.ts +1 -1
- package/package.json +4 -4
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,23 @@
|
|
|
1
1
|
# @atlaskit/ads-mcp
|
|
2
2
|
|
|
3
|
+
## 1.3.1
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- [`84967ba6663a1`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/84967ba6663a1) -
|
|
8
|
+
Add missing Atlaskit utilities and hooks tools to the MCP server.
|
|
9
|
+
|
|
10
|
+
## 1.3.0
|
|
11
|
+
|
|
12
|
+
### Minor Changes
|
|
13
|
+
|
|
14
|
+
- [`f5a335ff3aa42`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/f5a335ff3aa42) -
|
|
15
|
+
Improve MCP tool routing guidance for ADS and public Atlaskit package fallback research.
|
|
16
|
+
|
|
17
|
+
### Patch Changes
|
|
18
|
+
|
|
19
|
+
- Updated dependencies
|
|
20
|
+
|
|
3
21
|
## 1.2.1
|
|
4
22
|
|
|
5
23
|
### Patch Changes
|
package/README.md
CHANGED
|
@@ -21,6 +21,7 @@ to help ensure your interfaces are accessible to all users.
|
|
|
21
21
|
|
|
22
22
|
- [Available Tools](#available-tools)
|
|
23
23
|
- [Design System Tools](#design-system-tools)
|
|
24
|
+
- [Atlaskit Fallback Research Tools](#atlaskit-fallback-research-tools)
|
|
24
25
|
- [Accessibility Tools](#accessibility-tools)
|
|
25
26
|
- [Accessibility Features](#accessibility-features)
|
|
26
27
|
- [Example Usage](#example-usage)
|
|
@@ -54,46 +55,74 @@ to help ensure your interfaces are accessible to all users.
|
|
|
54
55
|
|
|
55
56
|
- `ads_get_all_tokens` - Get all available design tokens for colors, spacing, typography, etc.
|
|
56
57
|
- `ads_search_tokens` - Search for specific design tokens by name, description, or example values
|
|
57
|
-
- `ads_get_all_components` - Get all
|
|
58
|
-
- `ads_search_components` - Search
|
|
58
|
+
- `ads_get_all_components` - Get all canonical ADS components with basic information (full catalog)
|
|
59
|
+
- `ads_search_components` - Search canonical ADS components by name, description, category, or
|
|
60
|
+
package name
|
|
59
61
|
- `ads_get_all_icons` - Get all available icons from the design system
|
|
60
62
|
- `ads_search_icons` - Search for specific icons by name, keywords, or categorization
|
|
61
63
|
- `ads_plan` - Search for multiple design system resources (tokens, icons, components) in a single
|
|
62
64
|
efficient operation
|
|
63
65
|
|
|
66
|
+
Use `ads_*` tools first for standard UI work. They are the canonical source for ADS components,
|
|
67
|
+
tokens, icons, foundations, accessibility, lint rules, i18n, and migrations.
|
|
68
|
+
|
|
69
|
+
### Atlaskit Fallback Research Tools
|
|
70
|
+
|
|
71
|
+
- `atlaskit_get_components` - Get a compact inventory of public `@atlaskit/*` component packages
|
|
72
|
+
outside the ADS catalog
|
|
73
|
+
- `atlaskit_search_components` - Search non-ADS public `@atlaskit/*` components with examples and
|
|
74
|
+
props
|
|
75
|
+
- `atlaskit_get_hooks` - Get a compact inventory of public `@atlaskit/*` hooks outside the ADS
|
|
76
|
+
catalog
|
|
77
|
+
- `atlaskit_search_hooks` - Search non-ADS public `@atlaskit/*` hooks with usage details
|
|
78
|
+
- `atlaskit_get_utilities` - Get a compact inventory of public `@atlaskit/*` utilities outside the
|
|
79
|
+
ADS catalog
|
|
80
|
+
- `atlaskit_search_utilities` - Search non-ADS public `@atlaskit/*` utilities with usage details
|
|
81
|
+
|
|
82
|
+
Use `atlaskit_*` tools for fallback research when an ADS search has no useful match, or when you are
|
|
83
|
+
looking for a public `@atlaskit/*` package that is not part of ADS. Do not treat Atlaskit results as
|
|
84
|
+
equal-priority replacements for ADS components in standard UI decisions.
|
|
85
|
+
|
|
64
86
|
#### Design System Tools Usage
|
|
65
87
|
|
|
66
88
|
```typescript
|
|
67
|
-
// Search for components (recommended approach)
|
|
68
|
-
const buttonComponents = await
|
|
89
|
+
// Search for canonical ADS components (recommended approach)
|
|
90
|
+
const buttonComponents = await ads_search_components({
|
|
69
91
|
terms: ['button', 'click'],
|
|
70
92
|
limit: 3,
|
|
71
93
|
});
|
|
72
94
|
|
|
73
95
|
// Search for specific tokens
|
|
74
|
-
const colorTokens = await
|
|
96
|
+
const colorTokens = await ads_search_tokens({
|
|
75
97
|
terms: ['color.text', 'primary'],
|
|
76
98
|
limit: 5,
|
|
77
99
|
});
|
|
78
100
|
|
|
79
101
|
// Search for icons
|
|
80
|
-
const addIcons = await
|
|
102
|
+
const addIcons = await ads_search_icons({
|
|
81
103
|
terms: ['add', 'plus', 'create'],
|
|
82
104
|
limit: 2,
|
|
83
105
|
});
|
|
84
106
|
|
|
85
107
|
// Search for multiple resources at once (most efficient for complex UI patterns)
|
|
86
|
-
const designResources = await
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
108
|
+
const designResources = await ads_plan({
|
|
109
|
+
tokens: ['color.text', 'space.100', 'radius.small'],
|
|
110
|
+
icons: ['add', 'edit', 'delete'],
|
|
111
|
+
components: ['Button', 'TextField', 'Modal'],
|
|
112
|
+
atlaskitComponents: [],
|
|
113
|
+
limit: 2,
|
|
114
|
+
});
|
|
115
|
+
|
|
116
|
+
// Search public @atlaskit/* packages only when ADS has no useful match
|
|
117
|
+
const atlaskitComponents = await atlaskit_search_components({
|
|
118
|
+
terms: ['editor-core', 'onboarding'],
|
|
90
119
|
limit: 2,
|
|
91
120
|
});
|
|
92
121
|
|
|
93
122
|
// Get all available items (fallback when search doesn't find what you need)
|
|
94
|
-
const allComponents = await
|
|
95
|
-
const allTokens = await
|
|
96
|
-
const allIcons = await
|
|
123
|
+
const allComponents = await ads_get_all_components();
|
|
124
|
+
const allTokens = await ads_get_all_tokens();
|
|
125
|
+
const allIcons = await ads_get_all_icons();
|
|
97
126
|
```
|
|
98
127
|
|
|
99
128
|
### Accessibility Tools
|
|
@@ -124,19 +153,19 @@ The ADS MCP server includes comprehensive accessibility analysis and guidance:
|
|
|
124
153
|
|
|
125
154
|
```typescript
|
|
126
155
|
// Analyze a component for accessibility issues using axe-core
|
|
127
|
-
const analysis = await
|
|
156
|
+
const analysis = await ads_analyze_a11y({
|
|
128
157
|
code: `<button onClick={handleClose}><CloseIcon /></button>`,
|
|
129
158
|
componentName: 'CloseButton',
|
|
130
159
|
includePatternAnalysis: true, // Also include pattern-based analysis
|
|
131
160
|
});
|
|
132
161
|
|
|
133
162
|
// Get specific accessibility guidelines
|
|
134
|
-
const guidelines = await
|
|
163
|
+
const guidelines = await ads_get_a11y_guidelines({
|
|
135
164
|
topic: 'buttons',
|
|
136
165
|
});
|
|
137
166
|
|
|
138
167
|
// Get fix suggestions for a violation
|
|
139
|
-
const fixes = await
|
|
168
|
+
const fixes = await ads_suggest_a11y_fixes({
|
|
140
169
|
violation: 'Button missing accessible label',
|
|
141
170
|
code: `<button onClick={handleClose}><CloseIcon /></button>`,
|
|
142
171
|
});
|
|
@@ -426,6 +455,26 @@ running it from, but you should force it like so:
|
|
|
426
455
|
}
|
|
427
456
|
```
|
|
428
457
|
|
|
458
|
+
## Maintainer release workflow (AFM)
|
|
459
|
+
|
|
460
|
+
When ADS structured content changes:
|
|
461
|
+
|
|
462
|
+
1. From `platform/`, run combined codegen once:
|
|
463
|
+
|
|
464
|
+
```bash
|
|
465
|
+
yarn workspace @af/ads-ai-tooling codegen
|
|
466
|
+
```
|
|
467
|
+
|
|
468
|
+
2. Commit updated generated MCP outputs in this package.
|
|
469
|
+
3. Create and ship the `@atlaskit/ads-mcp` changeset/release as usual.
|
|
470
|
+
4. Wait for the package publish.
|
|
471
|
+
5. Renovate should bump it in
|
|
472
|
+
[atlassian-mcp-micros](https://bitbucket.org/atlassian/atlassian-mcp-micros/).
|
|
473
|
+
6. Redeploy `atlassian-mcp-micros` after the bump lands (async pipeline).
|
|
474
|
+
|
|
475
|
+
For other generated targets (skills/DESIGN.md/offerings), follow `platform/tmp/*-instructions.md`
|
|
476
|
+
and the destination README in `atlassian/skills`.
|
|
477
|
+
|
|
429
478
|
## FAQs
|
|
430
479
|
|
|
431
480
|
1. I'm seeing an error like "Error: Cannot find module
|
package/dist/cjs/instructions.js
CHANGED
|
@@ -4,4 +4,4 @@ Object.defineProperty(exports, "__esModule", {
|
|
|
4
4
|
value: true
|
|
5
5
|
});
|
|
6
6
|
exports.instructions = void 0;
|
|
7
|
-
var instructions = exports.instructions = "\nYou are an expert in the Atlassian Design System (ADS).\nYou can search for tokens, icons, and components and return guidance on how to build user interfaces.\nYou have special accessibility knowledge and can ensure interfaces built with ADS components are accessible to all users.\nYou can analyze code for accessibility violations, provide specific fix suggestions, and offer guidance on accessibility best practices.\nFor org-wide standards alongside ADS tools: pair Context Engine `get_accessibility_docs` with `ads_get_a11y_guidelines`, `get_content_standards_docs` with `ads_get_guidelines`, and `get_i18n_docs` with `ads_i18n_conversion_guide` (Traduki/i18n policy plus the bundled formatMessage refactor guide).\nThese tools will support you, but for deep research you may also fetch https://atlassian.design/llms.txt, https://atlassian.design/llms-a11y.txt, or https://atlassian.design/ directly.\n";
|
|
7
|
+
var instructions = exports.instructions = "\nYou are an expert in the Atlassian Design System (ADS).\nYou can search for tokens, icons, and components and return guidance on how to build user interfaces.\nUse ads_* tools for canonical ADS resources: components, tokens, icons, foundations, accessibility, lint rules, i18n, and migrations.\nUse atlaskit_* tools only for further research into public @atlaskit/* scoped packages that are not covered by the ADS catalog, such as non-ADS components, hooks, and utilities. Prefer ADS resources first for standard UI.\nYou have special accessibility knowledge and can ensure interfaces built with ADS components are accessible to all users.\nYou can analyze code for accessibility violations, provide specific fix suggestions, and offer guidance on accessibility best practices.\nFor org-wide standards alongside ADS tools: pair Context Engine `get_accessibility_docs` with `ads_get_a11y_guidelines`, `get_content_standards_docs` with `ads_get_guidelines`, and `get_i18n_docs` with `ads_i18n_conversion_guide` (Traduki/i18n policy plus the bundled formatMessage refactor guide).\nThese tools will support you, but for deep research you may also fetch https://atlassian.design/llms.txt, https://atlassian.design/llms-a11y.txt, or https://atlassian.design/ directly.\n";
|
|
@@ -10,7 +10,7 @@ var _zodToJsonSchema = require("../../helpers/zod-to-json-schema");
|
|
|
10
10
|
|
|
11
11
|
var listGetAllComponentsTool = exports.listGetAllComponentsTool = {
|
|
12
12
|
name: 'ads_get_all_components',
|
|
13
|
-
description: "Returns **every** Atlassian Design System component record as separate JSON text chunks (full catalog; large payload)
|
|
13
|
+
description: "Returns **every** canonical Atlassian Design System (ADS) component record as separate JSON text chunks (full catalog; large payload). For non-ADS public `@atlaskit/*` packages, use `atlaskit_get_components` or `atlaskit_search_components`.\n\nWHEN TO USE:\nLast resort when `ads_plan` / `ads_search_components` is insufficient and you must enumerate all components. Prefer search for normal component picking.\n\nNo parameters.",
|
|
14
14
|
annotations: {
|
|
15
15
|
title: 'Get all ADS components',
|
|
16
16
|
readOnlyHint: true,
|