# astrbot-mcp

AstrBot MCP Server — 提供 AstrBot 插件开发相关的工具接口。

## 功能

- **get_doc**: 获取 AstrBot 开发文档内容
- **list_docs**: 列出所有可用文档
- **search_docs**: 按关键词搜索文档
- **get_hook_inventory**: 获取完整的 Hook 清单

## 安装

### 前置要求

- Python 3.10+
- [AstrBot-Skill](https://github.com/EterUltimate/AstrBot-Skill) 仓库（提供文档引用）

### 配置

1. Clone 本仓库和 AstrBot-Skill 到同一目录下：

```bash
mkdir astrbot-workspace && cd astrbot-workspace
git clone https://github.com/EterUltimate/AstrBot-Skill.git
git clone https://github.com/EterUltimate/astrbot-mcp.git
```

2. 安装依赖：

```bash
cd astrbot-mcp
pip install -r requirements.txt
```

3. 按需修改 `config.yaml` 中的路径配置（默认会自动找到相邻的 AstrBot-Skill 仓库）。

### 运行

```bash
python server.py
```

## 配置说明

`config.yaml` 关键配置项：

| 字段 | 说明 | 默认值 |
| :--- | :--- | :--- |
| `docs.base_path` | 文档引用目录路径 | `../AstrBot-Skill/skill-astrbot-dev/references` |
| `hooks.generator_script` | Hook 清单生成脚本路径 | `../AstrBot-Skill/scripts/generate_hook_inventory.py` |
| `hooks.output_path` | Hook 清单输出路径 | `../AstrBot-Skill/skill-astrbot-dev/.tmp/hook_inventory` |
| `server.transport` | 传输方式 | `stdio` |
| `sse.host` | SSE 主机（transport=sse 时） | `localhost` |
| `sse.port` | SSE 端口 | `3000` |

路径支持相对路径（基于 config.yaml 所在目录）和绝对路径。

## 与 AstrBot-Skill 的关系

本仓库是 [AstrBot-Skill](https://github.com/EterUltimate/AstrBot-Skill) 的 MCP 服务端拆分。
文档内容存储在 AstrBot-Skill 仓库的 `skill-astrbot-dev/references/` 目录中，
本服务通过文件系统读取并提供 MCP 工具接口。

## License

MIT