xby-fluent

Readme

# xby-fluent

DeepSeek Harness (DSH) 的插件：文档导航服务

一个帮助AI助手高效导航ANSYS Fluent在线文档的模型上下文协议（MCP）服务器，提供智能URL导航、预映射主题路径和官方文档链接。

## 功能

- **set_xby_apikey** — 在聊天中设置 API 密钥（自动持久化，重启有效）
- **search_help** — Find ANSYS Fluent documentation URLs for your query.

This tool helps you navigate to the right online documentation.
Use WebFetch to retrieve the actual content from the returned URLs.

Args:
    query: Search term (e.g., "flamelet model", "read case", "turbulence")
    max_suggestions: Maximum manual section suggestions to return (default: 3)

Returns:
    URLs and navigation hints for finding the documentation
- **list_topics** — List common Fluent topics with quick documentation links.

Returns:
    List of pre-mapped topics for faster navigation
- **get_manual_link** — Get direct link to a specific Fluent manual or section.

Args:
    manual: Manual name (user_guide, tui, theory, udf)
    section: Optional section path (e.g., "turbulence", "file/read-case")

Returns:
    Direct URL to the manual or section

## 安装

### 方式一：从 GitHub 直接安装（推荐）

```bash
# 格式: dsh plugin --profile <profile> add github:<owner>/<repo>
dsh plugin --profile web add github:xby_skill/xby-fluent
```

### 方式二：从本地目录安装（开发模式）

```bash
# 仅用于本地开发调试
dsh plugin --profile web add /absolute/path/to/xby-fluent
```

### 方式三：通过 cordis.patch.yml 开发调试

```bash
dsh web --profile web --patch /absolute/path/to/dsh-ocr-plugin/cordis.patch.yml
```



## 配置

### 获取 API 密钥

前往 [小笨羊官网](https://xiaobenyang.com) 注册并获取 API 密钥。