# Runoob MCP Server 📚

一个用于查询菜鸟教程资料的 MCP (Model Context Protocol) 服务器。

## 功能特性

- 🔍 **搜索教程**: 搜索菜鸟教程网站上的教程内容
- 📖 **获取教程详情**: 获取指定教程的详细内容
- 📋 **列出分类**: 列出菜鸟教程的所有分类
- 🎯 **热门教程**: 获取热门教程列表

## 安装

### 方式一：使用 pip 安装

```bash
cd runoob-mcp-server
pip install -e .
```

### 方式二：使用 uvx (推荐)

```bash
uvx install runoob-mcp-server
```

## 配置 VSCode 使用

### 1. 安装 Claude Desktop 或其他支持 MCP 的客户端

确保你已安装支持 MCP 的客户端，如：
- Claude Desktop
- Continue (VSCode 扩展)
- Cursor

### 2. 配置 MCP 服务器

#### Claude Desktop 配置

编辑配置文件：
- **macOS**: `~/Library/Application Support/Claude/claude_desktop_config.json`
- **Windows**: `%APPDATA%\Claude\claude_desktop_config.json`
- **Linux**: `~/.config/Claude/claude_desktop_config.json`

添加以下配置：

```json
{
  "mcpServers": {
    "runoob": {
      "command": "python",
      "args": ["/path/to/runoob-mcp-server/src/runoob_mcp_server/__init__.py"]
    }
  }
}
```

#### VSCode + Continue 扩展配置

在 VSCode 中安装 Continue 扩展，然后编辑 `~/.continue/config.json`：

```json
{
  "models": [...],
  "mcpServers": [
    {
      "name": "runoob",
      "transport": {
        "type": "stdio",
        "command": "python",
        "args": ["/path/to/runoob-mcp-server/src/runoob_mcp_server/__init__.py"]
      }
    }
  ]
}
```


### 3. 重启客户端

配置完成后，重启 Claude Desktop / VSCode / Cursor 即可使用。

## 可用工具

### 1. `runoob_search` - 搜索教程

搜索菜鸟教程网站上的内容。

**参数:**
- `query` (string): 搜索关键词
- `limit` (number, 可选): 返回结果数量，默认 10

**示例:**
```
搜索 Python 教程
```

### 2. `runoob_get_tutorial` - 获取教程详情

获取指定教程的详细内容。

**参数:**
- `url` (string): 教程的 URL

**示例:**
```
获取 https://www.runoob.com/python3/python3-tutorial.html 的内容
```

### 3. `runoob_list_categories` - 列出分类

列出菜鸟教程的所有分类。

### 4. `runoob_hot_tutorials` - 热门教程

获取热门教程列表。

**参数:**
- `category` (string, 可选): 分类名称，如 "Python", "Java" 等

## 使用示例

在 Claude Desktop 或支持 MCP 的客户端中：

```
用户: 帮我搜索 Python 基础教程
AI: [调用 runoob_search 工具] 找到以下教程...

用户: 获取 Python3 教程的详细内容
AI: [调用 runoob_get_tutorial 工具] 这是 Python3 教程的内容...
```

## 开发

```bash
# 安装开发依赖
pip install -e ".[dev]"

# 运行测试
pytest tests/
```

## 许可证

MIT License