50 lines
1.1 KiB
Markdown
50 lines
1.1 KiB
Markdown
# list_modules
|
||
|
||
列出项目中的所有模块及其描述信息。
|
||
|
||
## 参数
|
||
|
||
无参数。
|
||
|
||
## 返回结果
|
||
|
||
```json
|
||
[
|
||
{
|
||
"id": "mod_abc123",
|
||
"name": "Payments",
|
||
"description": "Manage charges, refunds, and payment intents",
|
||
"endpointCount": 15
|
||
},
|
||
{
|
||
"id": "mod_def456",
|
||
"name": "Customers",
|
||
"description": "Create and manage customer records",
|
||
"endpointCount": 8
|
||
}
|
||
]
|
||
```
|
||
|
||
## 返回字段说明
|
||
|
||
| 字段 | 类型 | 说明 |
|
||
|------|------|------|
|
||
| `id` | string | 模块 ID，用于 `list_endpoints` 和 `search_endpoints` |
|
||
| `name` | string | 模块名称 |
|
||
| `description` | string | 模块描述 |
|
||
| `endpointCount` | number | 模块中的端点数量 |
|
||
|
||
## Token 消耗
|
||
|
||
约 **100-300 tokens**，取决于模块数量。
|
||
|
||
## 使用场景
|
||
|
||
- 需要查看模块的详细描述（`get_project_overview` 不包含描述）
|
||
- 决定要探索哪个模块时
|
||
- 需要获取模块 ID 用于后续调用
|
||
|
||
## 与 get_project_overview 的区别
|
||
|
||
`get_project_overview` 返回的模块列表只包含 id、名称和端点数量，不包含描述。如果需要模块描述来判断探索哪个模块，使用 `list_modules`。
|