docs(README): 更新文档格式和API接口说明

- 修复JSON代码块格式错误,统一使用正确的语法高亮标记
- 调整MCP工具接口列表的缩进格式,提升文档可读性
- 优化技术实现部分的列表格式,统一缩进样式
- 添加日志管理章节的格式调整
- 补充缺失的代码块结束标记
```
This commit is contained in:
火焰库拉
2026-01-29 16:27:26 +08:00
parent 9d958316ef
commit 0a8124dafd

View File

@@ -51,18 +51,15 @@ Args: [你的项目所在盘符]:/[项目路径]/packages/mcp-bridge/mcp-proxy.j
### 或者添加 JSON 配置: ### 或者添加 JSON 配置:
``json ```json
{ {
"mcpServers": { "mcpServers": {
"cocos-creator": { "cocos-creator": {
"command": "node", "command": "node",
"args": [ "args": ["[Cocos Creator 项目的绝对路径]/packages/mcp-bridge/mcp-proxy.js"]
"[Cocos Creator 项目的绝对路径]/packages/mcp-bridge/mcp-proxy.js"
]
} }
} }
} }
``` ```
注意:请将上述配置中的路径替换为你自己项目中 `mcp-proxy.js` 文件的实际绝对路径。 注意:请将上述配置中的路径替换为你自己项目中 `mcp-proxy.js` 文件的实际绝对路径。
@@ -72,24 +69,29 @@ Args: [你的项目所在盘符]:/[项目路径]/packages/mcp-bridge/mcp-proxy.j
服务提供以下 MCP 工具接口: 服务提供以下 MCP 工具接口:
### 1. get_selected_node ### 1. get_selected_node
- **描述**: 获取当前编辑器中选中的节点 ID - **描述**: 获取当前编辑器中选中的节点 ID
- **参数**: 无 - **参数**: 无
### 2. set_node_name ### 2. set_node_name
- **描述**: 修改指定节点的名称 - **描述**: 修改指定节点的名称
- **参数**: - **参数**:
- `id`: 节点的 UUID - `id`: 节点的 UUID
- `newName`: 新的节点名称 - `newName`: 新的节点名称
### 3. save_scene ### 3. save_scene
- **描述**: 保存当前场景的修改 - **描述**: 保存当前场景的修改
- **参数**: 无 - **参数**: 无
### 4. get_scene_hierarchy ### 4. get_scene_hierarchy
- **描述**: 获取当前场景的完整节点树结构(包括 UUID、名称和层级关系 - **描述**: 获取当前场景的完整节点树结构(包括 UUID、名称和层级关系
- **参数**: 无 - **参数**: 无
### 5. update_node_transform ### 5. update_node_transform
- **描述**: 修改节点的坐标、缩放或颜色 - **描述**: 修改节点的坐标、缩放或颜色
- **参数**: - **参数**:
- `id`: 节点 UUID - `id`: 节点 UUID
@@ -98,22 +100,26 @@ Args: [你的项目所在盘符]:/[项目路径]/packages/mcp-bridge/mcp-proxy.j
- `color`: HEX 颜色代码(如 #FF0000 - `color`: HEX 颜色代码(如 #FF0000
### 6. create_scene ### 6. create_scene
- **描述**: 在 assets 目录下创建一个新的场景文件 - **描述**: 在 assets 目录下创建一个新的场景文件
- **参数**: - **参数**:
- `sceneName`: 场景名称 - `sceneName`: 场景名称
### 7. create_prefab ### 7. create_prefab
- **描述**: 将场景中的某个节点保存为预制体资源 - **描述**: 将场景中的某个节点保存为预制体资源
- **参数**: - **参数**:
- `nodeId`: 节点 UUID - `nodeId`: 节点 UUID
- `prefabName`: 预制体名称 - `prefabName`: 预制体名称
### 8. open_scene ### 8. open_scene
- **描述**: 在编辑器中打开指定的场景文件 - **描述**: 在编辑器中打开指定的场景文件
- **参数**: - **参数**:
- `url`: 场景资源路径,如 `db://assets/NewScene.fire` - `url`: 场景资源路径,如 `db://assets/NewScene.fire`
### 9. create_node ### 9. create_node
- **描述**: 在当前场景中创建一个新节点 - **描述**: 在当前场景中创建一个新节点
- **参数**: - **参数**:
- `name`: 节点名称 - `name`: 节点名称
@@ -164,6 +170,7 @@ Args: [你的项目所在盘符]:/[项目路径]/packages/mcp-bridge/mcp-proxy.j
### 日志管理 ### 日志管理
插件会记录所有操作的日志,包括: 插件会记录所有操作的日志,包括:
- 服务启动/停止 - 服务启动/停止
- MCP 请求接收 - MCP 请求接收
- 操作成功/失败状态 - 操作成功/失败状态
@@ -183,4 +190,7 @@ Args: [你的项目所在盘符]:/[项目路径]/packages/mcp-bridge/mcp-proxy.j
## 许可证 ## 许可证
MIT License MIT License
```
``` ```