# mm API接口文档编写

编写mm_os框架API接口文档。触发关键词：API文档、接口文档、mm文档。

## 执行步骤

### 步骤1：读取相关常识知识
使用 `read_knowledge knowledge_name='mm_os_framework'`、`read_knowledge knowledge_name='data_query_syntax'`、`read_knowledge knowledge_name='naming_conventions'`

### 步骤2：读取工作提示词
使用 `read_work work_name='document_mm_api'`、`read_work work_name='script_mm_api'`

### 步骤3：收集接口信息
使用 `read_text` 读取api.json和index.js。

### 步骤4：编写接口说明
使用 `write_text` 编写接口描述。

### 步骤5：编写参数文档
列出每个接口的入参、类型、必填和默认值。

### 步骤6：编写错误码说明
整理接口返回的错误码和含义。

### 步骤7：输出接口文档
使用 `write_text` 输出完整API接口文档。

## 输出成果
1. API接口文档

## 失败处理
- 若接口定义不完整，标注待补充
- 若描述与实际不符，以代码实现为准并修正

## 禁止行为
- ❌ 禁止文档与代码实现不一致
- ❌ 禁止省略参数的类型说明