xgodo mcp服务器
用于Xgodo Automation API文档访问的MCP服务器。提供用于搜索、列出和阅读Xgodo Android自动化框架文档的工具。
安装```bash
bun install
## 用法
### 发展```bash
bun run dev
构建与运行```bash
bun run build
bun run start
## 可用工具
|工具|说明|
|------|-------------|
| `xgodo_list_documents` |列出所有可用的存储文档|
| `xgodo_read_document` |从特定文档中读取内容|
| `xgodo_search_documents` |在所有文档中搜索文本|
| `xgodo_list_agent_actions` |列出agent.actions方法类别|
| `xgodo_list_agent_utils` |列出agent.utils方法类别|
| `xgodo_get_types` |获取TypeScript类型定义|
### 工具详细信息
#### `xgodo_list_documents`
列出所有可用的文档文件。
**参数:**
- `response_format`:输出格式(`"markdown"` | `"json"`,默认值: `"markdown"`)
**退货:**
- `total`:文件数量
- `documents`:文档名称数组
#### `xgodo_read_document`
读取特定文档的完整内容。
**参数:**
- `name`:文档名称无 `.md` 扩展(例如。, `"agent-actions/touch"`)
- `response_format`:输出格式(`"markdown"` | `"json"`,默认值: `"markdown"`)
**退货:**
- `name`:文档名称
- `content`:完整文档内容
- `size`:内容大小(以字符为单位)
#### `xgodo_search_documents`
在所有文档中搜索文本。
**参数:**
- `query`:搜索文本(不区分大小写)
- `response_format`:输出格式(`"markdown"` | `"json"`,默认值: `"markdown"`)
**退货:**
- `query`:搜索查询
- `totalMatches`:找到的匹配行总数
- `results`:数组 `{ filePath, matchingLines }`
#### `xgodo_list_agent_actions`
可用列表 `agent.actions` 方法类别。
**参数:**
- `response_format`:输出格式(`"markdown"` | `"json"`,默认值: `"markdown"`)
**退货:**
- `categories`:数组 `{ name, description }`
类别包括: `apps`, `files`, `navigation`, `network`, `screen`, `text`, `touch`
#### `xgodo_list_agent_utils`
可用列表 `agent.utils` 方法类别。
**参数:**
- `response_format`:输出格式(`"markdown"` | `"json"`,默认值: `"markdown"`)
**退货:**
- `categories`:数组 `{ name, description }`
类别包括: `callbacks`, `control`, `display`, `files`, `helpers`, `info`, `job`, `out-of-steps`
#### `xgodo_get_types`
返回Xgodo API的TypeScript类型定义。
**参数:**
- `response_format`:输出格式(`"markdown"` | `"json"`,默认值: `"markdown"`)
**退货:**
- `content`:TypeScript类型定义
- `size`:内容大小(以字符为单位)
## 报废文件
要从URL获取新文档,请执行以下操作:```bash
bun run scrape
编辑 src/scripts/scrape.ts 添加新的网址进行抓取。
MCP配置
添加到MCP客户端配置中:json
{
"mcpServers": {
"xgodo": {
"command": "bun",
"args": ["run", "/path/to/xgodo-mcp-server/build/index.js"]
}
}
}
许可证
ISC
