Merge pull request #15 from mastergo-design/feature_meta

update readme & add version

Author: yansanmu90

README.md

@@ -81,6 +81,54 @@ 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
+
+#### src/markdown
+
+Contains markdown files with additional documentation:
+
+- `meta.md`: Documentation about metadata structure and usage
+
+## 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

README.zh-CN.md

@@ -81,6 +81,54 @@ 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`：获取元数据信息的工具
+
+#### src/markdown
+
+包含附加文档的 markdown 文件：
+
+- `meta.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

src/index.ts

@@ -6,6 +6,7 @@ import { HttpUtil } from "./http-util";
 import { GetDslTool } from "./tools/get-dsl";
 import { GetComponentLinkTool } from "./tools/get-component-link";
 import { GetMetaTool } from "./tools/get-meta";
+import { GetVersionTool } from "./tools/get-version";
 
 // Logging function, only outputs when the DEBUG environment variable is true
 const log = (message: string) => {
@@ -39,6 +40,7 @@ function main() {
   const httpUtil = new HttpUtil(baseUrl, token);
 
   // Register tools
+  new GetVersionTool().register(server);
   new GetDslTool(httpUtil).register(server);
   new GetComponentLinkTool(httpUtil).register(server);
   new GetMetaTool(httpUtil).register(server);

src/markdown/meta.md

@@ -64,7 +64,7 @@ The data might be:
 }
 ```
 
-f you find that the node data of page 0:1 contains the `interactive` field with id 0:3, write the 0:3 page and add the navigation information:
+if you find that the node data of page 0:1 contains the `interactive` field with id 0:3, write the 0:3 page and add the navigation information:
 ```markdown
 
 ## Page List:

src/tools/get-version.ts

@@ -0,0 +1,28 @@
+import { z } from "zod";
+import { BaseTool } from "./base-tool";
+import packageJson from "../../package.json";
+
+const VERSION_TOOL_NAME = `version_${packageJson.version}`;
+const VERSION_TOOL_DESCRIPTION = `the current version is ${packageJson.version}`;
+
+export class GetVersionTool extends BaseTool {
+  name = VERSION_TOOL_NAME;
+  description = VERSION_TOOL_DESCRIPTION;
+
+  constructor() {
+    super();
+  }
+
+  schema = z.object({});
+
+  async execute({}: z.infer<typeof this.schema>) {
+    return {
+      content: [
+        {
+          type: "text" as const,
+          text: JSON.stringify(packageJson.version),
+        },
+      ],
+    };
+  }
+}