@mastergo/magic-mcp 0.0.4-beta.8 → 0.0.4

package/README.md

@@ -1,21 +1,19 @@
 # MasterGo Magic MCP
+[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/mastergo-design/mastergo-magic-mcp)
 
 MasterGo Magic MCP is a standalone MCP (Model Context Protocol) service designed to connect MasterGo design tools with AI models. It enables AI models to directly retrieve DSL data from MasterGo design files.
 
 ## Key Features
-
 - Retrieves DSL data from MasterGo design files
 - Runs directly with npx
 - No external dependencies required, only Node.js environment needed
 
 ## Tutorial
-
 - https://mastergo.com/file/155675508499265?page_id=158:0002
 
 ## Usage
 
 ### Obtaining MG_MCP_TOKEN
-
 1. Visit https://mastergo.com
 2. Enter personal settings
 3. Click the Security Settings tab
@@ -23,26 +21,51 @@ MasterGo Magic MCP is a standalone MCP (Model Context Protocol) service designed
 5. Click to generate the token
 
 ### Command Line Options
-
 ```
 npx @mastergo/magic-mcp --token=YOUR_TOKEN [--url=API_URL] [--rule=RULE_NAME] [--debug]
 ```
 
 #### Parameters:
-
 - `--token=YOUR_TOKEN` (required): MasterGo API token for authentication
 - `--url=API_URL` (optional): API base URL, defaults to http://localhost:3000
 - `--rule=RULE_NAME` (optional): Add design rules to apply, can be used multiple times
 - `--debug` (optional): Enable debug mode for detailed error information
 
 You can also use space-separated format for parameters:
-
 ```
 npx @mastergo/magic-mcp --token YOUR_TOKEN --url API_URL --rule RULE_NAME --debug
 ```
 
-### cursor Usage
+### Installing via Smithery
+
+To install MasterGo Magic for Claude Desktop automatically via [Smithery](https://smithery.ai/server/@mastergo-design/mastergo-magic-mcp):
+
+```bash
+npx -y @smithery/cli install @mastergo-design/mastergo-magic-mcp --client claude
+```
+
+### LINGMA Usage
+Search for LINGMA in the VSCode extension marketplace and install it.
+
+<img src="https://github.com/mastergo-design/mastergo-magic-mcp/blob/main/images/image-20250507174245589.png" alt="image-20250507174245589" style="zoom:25%;" />
+
+After logging in, click on [MCP tools] in the chat box.
+
+<img src="https://github.com/mastergo-design/mastergo-magic-mcp/blob/main/images/image-20250507174511910.png" alt="image-20250507174511910" style="zoom:25%;" />
+
+Click on [MCP Square] at the top to enter the MCP marketplace, find the MasterGo design collaboration tool and install it.
 
+<img src="https://github.com/mastergo-design/mastergo-magic-mcp/blob/main/images/image-20250507174840456.png" alt="image-20250507174840456" style="zoom:25%;" />
+
+After installation, go back to [MCP Servers], and edit our MCP service to replace it with your own MasterGo token.
+
+<img src="https://github.com/mastergo-design/mastergo-magic-mcp/blob/main/images/image-20250507175005364.png" alt="image-20250507175005364" style="zoom:25%;" />
+
+Finally, switch the chat mode to agent mode in the chat interface.
+
+<img src="https://github.com/mastergo-design/mastergo-magic-mcp/blob/main/images/image-20250507175107044.png" alt="image-20250507175107044" style="zoom:25%;" />
+
+### cursor Usage
 Cursor Mcp usage guide reference: https://docs.cursor.com/context/model-context-protocol#using-mcp-tools-in-agent
 
 ```json
@@ -63,7 +86,6 @@ Cursor Mcp usage guide reference: https://docs.cursor.com/context/model-context-
 ```
 
 ### cline Usage
-
 ```json
 {
   "mcpServers": {
@@ -82,9 +104,7 @@ Cursor Mcp usage guide reference: https://docs.cursor.com/context/model-context-
 ```
 
 ## Project Structure
-
 ### src Directory
-
 The `src` directory contains the core implementation of the MasterGo Magic MCP service:
 
 - `index.ts`: Entry point of the application that initializes the MCP server and registers all tools
@@ -92,7 +112,6 @@ The `src` directory contains the core implementation of the MasterGo Magic MCP s
 - `types.d.ts`: TypeScript type definitions for the project
 
 #### src/tools
-
 Contains implementations of MCP tools:
 
 - `base-tool.ts`: Base class for all MCP tools
@@ -102,14 +121,12 @@ Contains implementations of MCP tools:
 - `get-component-workflow.ts`: Tool providing structured component development workflow for Vue and React components, generating workflow files and component specifications
 
 #### src/markdown
-
 Contains markdown files with additional documentation:
 
 - `meta.md`: Documentation about metadata structure and usage
 - `component-workflow.md`: Component development workflow documentation guiding structured component development process
 
 ## Local Development
-
 1. Run `yarn` and `yarn build` to install dependencies and build the code
 2. Find the absolute path of `bin/cli.js`
 3. Add local MCP configuration with your token
@@ -126,7 +143,6 @@ Contains markdown files with additional documentation:
   "env": {}
 },
 ```
-
 4. Restart your editor to ensure the local MCP is enabled
 
 After successful execution, you can debug based on the local running results. You can build your own MCP service based on your modifications.
@@ -134,5 +150,4 @@ After successful execution, you can debug based on the local running results. Yo
 We welcome your code contributions and look forward to building MasterGo's MCP service together.
 
 ## License
-
 ISC

package/README.zh-CN.md

@@ -1,5 +1,7 @@
 # MasterGo Magic MCP
 
+[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/mastergo-design/mastergo-magic-mcp)
+
 MasterGo Magic MCP 是一个独立的 MCP（Model Context Protocol）服务，旨在连接 MasterGo 设计工具与 AI 模型。它使 AI 模型能够直接从 MasterGo 设计文件中获取 DSL 数据。
 
 ## 主要特性
@@ -8,7 +10,7 @@ MasterGo Magic MCP 是一个独立的 MCP（Model Context Protocol）服务，
 - 可直接通过 npx 运行
 - 仅需 Node.js 环境，无需其他外部依赖
 
-### 教程
+## 教程
 
 - https://mastergo.com/file/155675508499265?page_id=158:0002
 
@@ -41,6 +43,28 @@ npx @mastergo/magic-mcp --token=YOUR_TOKEN [--url=API_URL] [--rule=RULE_NAME] [-
 npx @mastergo/magic-mcp --token YOUR_TOKEN --url API_URL --rule RULE_NAME --debug
 ```
 
+### LINGMA 使用方法
+
+在 vscode 拓展市场中搜索 LINGMA -> 然后安装该拓展
+
+<img src="https://github.com/mastergo-design/mastergo-magic-mcp/blob/main/images/image-20250507174245589.png" alt="image-20250507174245589" style="zoom:25%;" />
+
+登录后 -> 在聊天框中点击 [MCP tools]
+
+<img src="https://github.com/mastergo-design/mastergo-magic-mcp/blob/main/images/image-20250507174511910.png" alt="image-20250507174511910" style="zoom:25%;" />
+
+点击顶部 [MCP Sqaure] 进入mcp市场，在市场中找到 Mastergo设计协作工具并安装
+
+<img src="https://github.com/mastergo-design/mastergo-magic-mcp/blob/main/images/image-20250507174840456.png" alt="image-20250507174840456" style="zoom:25%;" />
+
+安装完成后，需要回到 [MCP Servers], 并编辑我们的mcp服务，将自己的mastergo token 替换上去
+
+<img src="https://github.com/mastergo-design/mastergo-magic-mcp/blob/main/images/image-20250507175005364.png" alt="image-20250507175005364" style="zoom:25%;" />
+
+最后在聊天界面中将聊天模式切换为agent模式。
+
+<img src="https://github.com/mastergo-design/mastergo-magic-mcp/blob/main/images/image-20250507175107044.png" alt="image-20250507175107044" style="zoom:25%;" />
+
 ### Cursor 使用方法
 
 Cursor Mcp 使用指南参考：https://docs.cursor.com/context/model-context-protocol#using-mcp-tools-in-agent
@@ -108,11 +132,11 @@ Cursor Mcp 使用指南参考：https://docs.cursor.com/context/model-context-pr
 - `meta.md`：关于元数据结构和用法的文档
 - `component-workflow.md`：组件开发工作流程文档，指导结构化组件开发过程
 
-## 本地运行
+## 本地开发
 
-1. 运行`yarn`，`yarn build`。安装依赖并构建代码
-2. 查看`bin/cli.js`的绝对路径
-3. 在MCP配置中添加本地MCP配置，其中token为您换区的token
+1. 运行 `yarn` 和 `yarn build`，安装依赖并构建代码
+2. 查看 `bin/cli.js` 的绝对路径
+3. 在 MCP 配置中添加本地 MCP 配置，其中 token 为您获取的 token
 
 ```json
 "mastergo-mcp-local": {
@@ -127,11 +151,11 @@ Cursor Mcp 使用指南参考：https://docs.cursor.com/context/model-context-pr
 },
 ```
 
-4. 重启编辑器，确认本地mcp已开启
+4. 重启编辑器，确认本地 MCP 已开启
 
-运行成功后，就可以基于本地运行的结果进行调试。您可以基于自己的修改构建自己的MCP服务。
+运行成功后，就可以基于本地运行的结果进行调试。您可以基于自己的修改构建自己的 MCP 服务。
 
-欢迎您为我们提供代码贡献，并期待大家一起共建MasterGo的MCP服务。
+欢迎您为我们提供代码贡献，并期待大家一起共建 MasterGo 的 MCP 服务。
 
 ## 许可证
 

package/bin/cli.js

@@ -36,7 +36,7 @@ for (let i = 0; i < args.length; i++) {
 }
 
 // Check required arguments
-if (!token) {
+if (!token && !process.env.MASTERGO_API_TOKEN) {
   console.error("Error: Missing MasterGo API Token");
   console.error(
     "Usage: npx mastergo-magic-mcp --token=YOUR_TOKEN [--url=API_URL] [--rule=RULE_NAME]"
@@ -47,8 +47,8 @@ if (!token) {
 
 // Set environment variables
 const env = {
-  ...process.env,
   MASTERGO_API_TOKEN: token,
+  ...process.env,
   API_BASE_URL: baseUrl,
   DEBUG: debug ? "true" : "false",
   // Add RULES environment variable as stringified array