@taiga-ui/mcp 0.1.0-alpha.2 → 0.1.0-alpha.4

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.
Files changed (3) hide show
  1. package/README.md +58 -30
  2. package/dist/utils/list-components.js +2 -2
  3. package/package.json +3 -2
package/README.md CHANGED
@@ -1,24 +1,39 @@
1
- # Taiga UI MCP Server
1
+ ## Taiga UI MCP Server
2
2
 
3
3
  [![MCP Badge](https://lobehub.com/badge/mcp/taiga-family-taiga-ui-mcp?style=plastic)](https://lobehub.com/mcp/taiga-family-taiga-ui-mcp)
4
+ [![npm version](https://img.shields.io/npm/v/@taiga-ui/mcp.svg)](https://npmjs.com/package/@taiga-ui/mcp)
5
+
6
+ > 🚧 **Alpha Release**
7
+ > `@taiga-ui/mcp` is currently in **alpha**.
4
8
 
5
9
  > **🚀 The fastest way to integrate Taiga UI components into your AI workflow**
6
10
 
7
11
  A Model Context Protocol (MCP) server that provides AI assistants with comprehensive access to [Taiga UI](https://taiga-ui.dev) components. Seamlessly retrieve Taiga UI components implementations for your AI-powered development workflow.
8
12
 
9
- ## Integrate with Your Editor
13
+ ### Key Features
14
+
15
+ * **Docs + code snippets**. Full Taiga UI markdown plus ready Angular examples in one place.
16
+ * **Two MCP tools**. Discover with `get_list_components`, fetch examples via `get_component_example`.
17
+ * **Configurable & lightweight**. Swap source URL (stable/next) without local Angular install.
18
+
19
+ ### Requirements
20
+
21
+ - Node.js 18 or newer
22
+ - VS Code, Cursor, Windsurf, Claude Desktop, Goose or any other MCP client
10
23
 
11
- ### VS Code / Cursor
24
+ ### Getting started
12
25
 
13
- For `.vscode/mcp.json` or `.cursor/mcp.json`:
26
+ First, install the Taiga UI MCP server with your client.
27
+
28
+ **Standard config** works in most of the tools:
14
29
 
15
30
  ```json
16
31
  {
17
- "servers": {
32
+ "mcpServers": {
18
33
  "taiga-ui": {
19
34
  "command": "npx",
20
35
  "args": [
21
- "@taiga-ui/mcp@latest",
36
+ "@taiga-ui/mcp@latest", // now @taiga-ui/mcp@alpha to fetch most actual version
22
37
  "--source-url=https://taiga-ui.dev/llms-full.txt" // or file from "/next" version, if you want
23
38
  ]
24
39
  }
@@ -26,46 +41,59 @@ For `.vscode/mcp.json` or `.cursor/mcp.json`:
26
41
  }
27
42
  ```
28
43
 
29
- ## Provided Tools
44
+ ### Tools
45
+
46
+ <details>
47
+ <summary><b>Core automation</b></summary>
30
48
 
31
49
  1. `get_list_components { query?: string }`
32
50
 
33
- - Lists component / section identifiers (with fuzzy substring filtering) along with basic metadata (category, package, type).
34
- - Input: optional `query` string to filter IDs (case-insensitive substring).
35
- - Output: `{ items: [...], total, query }` strictly structured JSON.
51
+ - Lists component / section identifiers (with fuzzy substring filtering) along with basic metadata (category, package, type).
52
+ - Input: optional `query` string to filter IDs (case-insensitive substring).
53
+ - Output: strictly structured JSON containing `items`, `total`, `query`.
36
54
 
37
- ```
55
+ ```json
38
56
  {
39
- "items": [
40
- { "id": "components/Alert", "name": "Alert", "category": "components", "package": "CORE", "type": "component" }
41
- ],
42
- "total": 1,
43
- "query": null
57
+ "items": [
58
+ { "id": "components/Alert", "name": "Alert", "category": "components", "package": "CORE", "type": "component" }
59
+ ],
60
+ "total": 1,
61
+ "query": null
44
62
  }
45
63
  ```
46
64
 
47
65
  2. `get_component_example { "names": ["...", "..."] }`
48
66
 
49
- - Returns the full markdown content of each resolved section (entire component documentation). Applies fuzzy name resolution (variants: exact, segment, suffix, substring with Tui\* variants).
50
- - Input: `{ names: string[] }` (each >= 2 chars).
51
- - Output: per name object with `id` (present only if resolved), `package`, `type`, `suggestions` (only when unresolved), and `content` (array of code strings when example blocks exist; omitted otherwise). Top-level also includes `matched` (count of resolved names).
67
+ - Returns full markdown content for each resolved section (entire component documentation).
68
+ - Fuzzy name resolution: exact match, path segment, suffix, substring, and `Tui*` variants.
69
+ - Input: `{ names: string[] }` (each name length ≥ 2).
70
+ - Output: `results` array with objects: `query`, `id` (if resolved), `package`, `type`, `suggestions` (only when unresolved), `content` (array of code blocks, if examples exist). Top-level also includes `matched` (count of resolved names).
52
71
 
53
- ```
72
+ ```json
54
73
  {
55
- "results": [
56
- {
57
- "query": "Alert",
58
- "id": "components/Alert",
59
- "package": "CORE",
60
- "type": "component",
61
- "content": ["# components/Alert\n- **Package**: ... (full section markdown here)"]
62
- }
63
- ],
74
+ "results": [
75
+ {
76
+ "query": "Alert",
77
+ "id": "components/Alert",
78
+ "package": "CORE",
79
+ "type": "component",
80
+ "content": ["# components/Alert\n- **Package**: ... (full section markdown here)"]
81
+ }
82
+ ],
64
83
  "matched": 1
65
84
  }
66
85
  ```
67
86
 
68
- ## Authors
87
+ > Tip: Combine `get_list_components` to discover IDs and then fetch full implementation snippets with `get_component_example`.
88
+
89
+ </details>
90
+
91
+ ### Maintained
92
+
93
+ Taiga UI MCP is a part of [Taiga UI](https://github.com/taiga-family/taiga-ui) libraries family which is backed and used by a
94
+ large enterprise. This means you can rely on timely support and continuous development.
95
+
96
+ ### Authors
69
97
 
70
98
  <table>
71
99
  <tr>
package/dist/utils/list-components.js CHANGED
@@ -1,6 +1,6 @@
1
1
  import { state } from '../server/server.js';
2
- export function constructComponentsList(query) {
3
- const normalizedQuery = query ? query.toLowerCase() : null;
2
+ export function constructComponentsList(query = '') {
3
+ const normalizedQuery = query?.toLowerCase().replace(/^tui/, '');
4
4
  const items = state.sections
5
5
  .filter((section) => !normalizedQuery ||
6
6
  section.id.toLowerCase().includes(normalizedQuery))
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@taiga-ui/mcp",
3
- "version": "0.1.0-alpha.2",
3
+ "version": "0.1.0-alpha.4",
4
4
  "description": "Model Context Protocol server providing Taiga UI documentation search and scaffolding tools.",
5
5
  "type": "module",
6
6
  "main": "./dist/index.js",
@@ -41,7 +41,8 @@
41
41
  "clean": "rm -rf dist",
42
42
  "build": "npm run clean && tsc && chmod +x dist/index.js",
43
43
  "prepublishOnly": "npm run build",
44
- "release": "npm run build && npm publish --access public --tag alpha"
44
+ "release": "npm publish --access public --tag latest",
45
+ "postrelease": "npm dist-tag add @taiga-ui/mcp@$(node -p 'require(`./package.json`).version') alpha"
45
46
  },
46
47
  "engines": {
47
48
  "node": ">=18.0.0"