# MCP Inspector 调试参数指南
## 🚀 概述
经过架构优化，本服务已完成工具合并和注册顺序优化：
### 🎯 优化成果
- **工具数量**: 从12个优化为8个（减少33%）
- **API统一**: 通过action参数区分操作类型
- **智能验证**: 根据操作自动验证必需参数
- **完整注释**: 在MCP Inspector中可清楚查看所有参数说明
### 📁 工具分组架构
```
📁 1. 基础信息工具（最常用）
├── getSpace
└── getPageByPrettyUrl
📁 2. 页面管理工具（核心功能）
└── managePages ⭐️
📁 3. 评论管理工具（扩展功能）
├── manageComments ⭐️
├── getPageComments
└── getComment
📁 4. 搜索工具（专用搜索）
├── searchContent
└── searchComments
```
## 🛠️ managePages 工具参数
### action 参数
- **描述**: 操作类型: create=创建页面, update=更新页面, delete=删除页面, get=获取页面基本信息, getContent=获取页面详细内容
- **可选值**: `create` | `update` | `delete` | `get` | `getContent`
### 其他参数详细说明
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| `pageId` | string | 可选 | 页面ID（用于update/delete/get/getContent操作） |
| `spaceKey` | string | 可选 | 空间Key（用于create操作，必填） |
| `title` | string | 可选 | 页面标题（用于create操作必填，update操作可选） |
| `content` | string | 可选 | 页面内容（用于create操作必填，update操作可选） |
| `parentId` | string | 可选 | 父页面ID（可选，用于创建子页面） |
| `representation` | enum | 可选 | 内容格式: storage=HTML存储格式（推荐）, wiki=Wiki标记语法, editor2=编辑器格式, view=查看格式 |
| `version` | number | 可选 | 页面版本号（用于update操作，建议填写以避免冲突） |
| `expand` | string | 可选 | 扩展参数（可选，用于指定返回额外信息，如：body.storage,version,space） |
## 🗨️ manageComments 工具参数
### action 参数
- **描述**: 操作类型: create=创建评论, update=更新评论, delete=删除评论, reply=回复评论
- **可选值**: `create` | `update` | `delete` | `reply`
### commentType 参数
- **描述**: 评论类型: regular=普通评论（默认）, inline=行内评论
- **可选值**: `regular` | `inline`
- **默认值**: `regular`
### 其他参数详细说明
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| `pageId` | string | 可选 | 页面ID（用于create/reply操作时必填） |
| `commentId` | string | 可选 | 评论ID（用于update/delete操作必填，行内评论reply时必填） |
| `content` | string | 可选 | 评论内容（用于create/update/reply操作必填） |
| `representation` | enum | 可选 | 内容格式: storage=HTML存储格式（推荐）, wiki=Wiki标记语法, editor2=编辑器格式, view=查看格式 |
| `parentCommentId` | string | 可选 | 父评论ID（用于普通评论的reply操作必填，或创建子评论） |
| `version` | number | 可选 | 评论版本号（用于update操作，建议填写以避免冲突） |
| `watch` | boolean | 可选 | 是否监视评论（布尔值，默认false，用于reply操作） |
| `originalSelection` | string | 可选 | 原始选中文本（用于创建行内评论时必填） |
| `matchIndex` | number | 可选 | 匹配索引（当页面有多个相同文本时指定第几个，默认0） |
| `numMatches` | number | 可选 | 匹配总数（页面中相同文本的总数，默认1） |
| `serializedHighlights` | string | 可选 | 序列化高亮信息（JSON格式字符串，可选） |
## 📋 其他工具参数说明
### getSpace
- `spaceKey`: 空间Key（如：DEV, TECH, DOC 等）
### getPageByPrettyUrl
- `spaceKey`: 空间Key（如：DEV, TECH 等）
- `title`: 页面标题（精确匹配）
### searchContent
- `query`: 搜索关键词（支持中文和英文，将自动转换为CQL格式）
### getPageComments
- `pageId`: 页面ID
- `start`: 起始位置（分页参数，默认0）
- `limit`: 每页数量（分页参数，默认25）
### getComment
- `commentId`: 评论ID
### searchComments
- `query`: 搜索关键词（在评论内容中搜索）
- `start`: 起始位置（分页参数，默认0）
- `limit`: 每页数量（分页参数，默认25）
- `spaceKey`: 限定搜索的空间Key（可选）
## 🎯 调试示例
### 在 MCP Inspector 中创建页面
```json
{
"action": "create",
"spaceKey": "DEV",
"title": "测试页面",
"content": "<h1>标题</h1><p>内容</p>",
"representation": "storage"
}
```
### 在 MCP Inspector 中创建行内评论
```json
{
"action": "create",
"commentType": "inline",
"pageId": "123456",
"content": "这里需要优化",
"originalSelection": "代码片段"
}
```
### 在 MCP Inspector 中搜索内容
```json
{
"query": "API文档"
}
```
## 💡 调试技巧
1. **查看参数提示**: 在 MCP Inspector 中，每个参数框都会显示详细的说明文字
2. **必填参数检查**: 根据选择的 `action` 类型，确保填写了相应的必填参数
3. **参数组合**: 不同操作需要不同的参数组合，参考上表中的说明
4. **枚举值选择**: 对于 `action`、`commentType`、`representation` 等枚举类型，只能选择预定义的值
5. **错误信息**: 如果参数不正确，工具会返回具体的错误说明
## ⚡ 快速参考
### 页面操作快速参考
- **创建页面**: `action=create` + `spaceKey` + `title` + `content`
- **更新页面**: `action=update` + `pageId` + (`title` 或 `content`)
- **删除页面**: `action=delete` + `pageId`
- **获取页面**: `action=get` + `pageId`
### 评论操作快速参考
- **创建普通评论**: `action=create` + `commentType=regular` + `pageId` + `content`
- **创建行内评论**: `action=create` + `commentType=inline` + `pageId` + `content` + `originalSelection`
- **回复普通评论**: `action=reply` + `commentType=regular` + `pageId` + `parentCommentId` + `content`
- **回复行内评论**: `action=reply` + `commentType=inline` + `commentId` + `pageId` + `content`
这些参数注释将大大提升调试体验，让您在 MCP Inspector 中更容易理解和使用各种工具！
