@mastergo/magic-mcp 0.0.4-beta.5 → 0.0.4-beta.7

package/README.md

@@ -81,6 +81,58 @@ 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
+- `http-util.ts`: Utility for handling HTTP requests to the MasterGo API
+- `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
+- `get-dsl.ts`: Tool for retrieving DSL (Domain Specific Language) data from MasterGo design files
+- `get-component-link.ts`: Tool for retrieving component documentation from links
+- `get-meta.ts`: Tool for retrieving metadata information
+- `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
+
+```json
+"mastergo-mcp-local": {
+  "command": "node",
+  "args": [
+    "absolute/path/to/bin/cli.js",
+    "--token=mg_xxxxxx",
+    "--url=https://mastergo.com",
+    "--debug"
+  ],
+  "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.
+
+We welcome your code contributions and look forward to building MasterGo's MCP service together.
+
 ## License
 
 ISC

package/README.zh-CN.md

@@ -81,6 +81,58 @@ Cursor Mcp 使用指南参考：https://docs.cursor.com/context/model-context-pr
 }
 ```
 
+## 项目结构
+
+### src 目录
+
+`src` 目录包含 MasterGo Magic MCP 服务的核心实现：
+
+- `index.ts`：应用程序入口点，初始化 MCP 服务器并注册所有工具
+- `http-util.ts`：处理与 MasterGo API 通信的 HTTP 请求工具
+- `types.d.ts`：项目的 TypeScript 类型定义
+
+#### src/tools
+
+包含 MCP 工具的实现：
+
+- `base-tool.ts`：所有 MCP 工具的基类
+- `get-dsl.ts`：从 MasterGo 设计文件中获取 DSL（领域特定语言）数据的工具
+- `get-component-link.ts`：从链接中获取组件文档的工具
+- `get-meta.ts`：获取元数据信息的工具
+- `get-component-workflow.ts`：提供结构化的组件开发工作流工具，支持 Vue 和 React 组件开发，生成所需的工作流文件和组件规范
+
+#### src/markdown
+
+包含附加文档的 markdown 文件：
+
+- `meta.md`：关于元数据结构和用法的文档
+- `component-workflow.md`：组件开发工作流程文档，指导结构化组件开发过程
+
+## 本地运行
+
+1. 运行`yarn`，`yarn build`。安装依赖并构建代码
+2. 查看`bin/cli.js`的绝对路径
+3. 在MCP配置中添加本地MCP配置，其中token为您换区的token
+
+```json
+"mastergo-mcp-local": {
+  "command": "node",
+  "args": [
+    "bin/cli.js绝对路径地址",
+    "--token=mg_xxxxxx",
+    "--url=https://mastergo.com",
+    "--debug"
+  ],
+  "env": {}
+},
+```
+
+4. 重启编辑器，确认本地mcp已开启
+
+运行成功后，就可以基于本地运行的结果进行调试。您可以基于自己的修改构建自己的MCP服务。
+
+欢迎您为我们提供代码贡献，并期待大家一起共建MasterGo的MCP服务。
+
 ## 许可证
 
 ISC