docs: reorder Web UI table rows and remove outdated MCP server setup instructions

This commit is contained in:
wizardchen
2026-04-02 10:30:12 +08:00
committed by lyingbug
parent 54da98fc24
commit 301d75eb52
4 changed files with 16 additions and 262 deletions
+4 -59
View File
@@ -290,16 +290,16 @@ Once started, services will be available at:
### Web UI Interface
<table>
<tr>
<td><b>Knowledge Base Management</b><br/><img src="./docs/images/knowledgebases.png" alt="Knowledge Base Management"></td>
<td><b>Conversation Settings</b><br/><img src="./docs/images/settings.png" alt="Conversation Settings"></td>
</tr>
<tr>
<td colspan="2"><b>Intelligent Q&A Conversation</b><br/><img src="./docs/images/qa.png" alt="Intelligent Q&A Conversation"></td>
</tr>
<tr>
<td colspan="2"><b>Agent Mode Tool Call Process</b><br/><img src="./docs/images/agent-qa.png" alt="Agent Mode Tool Call Process"></td>
</tr>
<tr>
<td><b>Knowledge Base Management</b><br/><img src="./docs/images/knowledgebases.png" alt="Knowledge Base Management"></td>
<td><b>Conversation Settings</b><br/><img src="./docs/images/settings.png" alt="Conversation Settings"></td>
</tr>
</table>
**Knowledge Base Management:** Support for creating FAQ and document knowledge base types, with multiple import methods including drag-and-drop, folder import, and URL import. Automatically identifies document structures and extracts core knowledge to establish indexes. Supports tag management and online entry. The system clearly displays processing progress and document status, achieving efficient knowledge base management.
@@ -333,61 +333,6 @@ WeKnora serves as the core technology framework for the [WeChat Dialog Open Plat
git clone https://github.com/Tencent/WeKnora
```
#### 2️⃣ Configure MCP Server
> It is recommended to directly refer to the [MCP Configuration Guide](./mcp-server/MCP_CONFIG.md) for configuration.
Configure the MCP client to connect to the server:
```json
{
"mcpServers": {
"weknora": {
"args": [
"path/to/WeKnora/mcp-server/run_server.py"
],
"command": "python",
"env":{
"WEKNORA_API_KEY":"Enter your WeKnora instance, open developer tools, check the request header x-api-key starting with sk",
"WEKNORA_BASE_URL":"http(s)://your-weknora-address/api/v1"
}
}
}
}
```
Run directly using stdio command:
```
pip install weknora-mcp-server
python -m weknora-mcp-server
```
## 🔧 Initialization Configuration Guide
To help users quickly configure various models and reduce trial-and-error costs, we've improved the original configuration file initialization method by adding a Web UI interface for model configuration. Before using, please ensure the code is updated to the latest version. The specific steps are as follows:
If this is your first time using this project, you can skip steps ①② and go directly to steps ③④.
### ① Stop the services
```bash
docker compose down
```
### ② Clear existing data tables (recommended when no important data exists)
```bash
make clean-db
```
### ③ Compile and start services
```bash
docker compose up -d --build
```
### ④ Access Web UI
http://localhost
On your first visit, you will be automatically redirected to the registration/login page. After completing registration, please create a new knowledge base and finish the relevant settings on its configuration page.
## 📘 API Reference
+4 -70
View File
@@ -300,16 +300,16 @@ docker compose down
### Web UI 界面
<table>
<tr>
<td><b>知识库管理</b><br/><img src="./docs/images/knowledgebases.png" alt="知识库管理"></td>
<td><b>对话设置</b><br/><img src="./docs/images/settings.png" alt="对话设置"></td>
</tr>
<tr>
<td colspan="2"><b>智能问答对话</b><br/><img src="./docs/images/qa.png" alt="智能问答对话"></td>
</tr>
<tr>
<td colspan="2"><b>Agent模式工具调用过程</b><br/><img src="./docs/images/agent-qa.png" alt="Agent模式工具调用过程"></td>
</tr>
<tr>
<td><b>知识库管理</b><br/><img src="./docs/images/knowledgebases.png" alt="知识库管理"></td>
<td><b>对话设置</b><br/><img src="./docs/images/settings.png" alt="对话设置"></td>
</tr>
</table>
@@ -337,72 +337,6 @@ WeKnora 作为[微信对话开放平台](https://chatbot.weixin.qq.com)的核心
- **高效问题管理**:支持高频问题的独立分类管理,提供丰富的数据工具,确保回答精准可靠且易于维护
- **微信生态覆盖**:通过微信对话开放平台,WeKnora 的智能问答能力可无缝集成到公众号、小程序等微信场景中,提升用户交互体验
### 🔗 MCP 服务器访问已经部署好的 WeKnora
#### 1️⃣克隆储存库
```
git clone https://github.com/Tencent/WeKnora
```
#### 2️⃣配置MCP服务器
> 推荐直接参考 [MCP配置说明](./mcp-server/MCP_CONFIG.md) 进行配置。
mcp客户端配置服务器
```json
{
"mcpServers": {
"weknora": {
"args": [
"path/to/WeKnora/mcp-server/run_server.py"
],
"command": "python",
"env":{
"WEKNORA_API_KEY":"进入你的weknora实例,打开开发者工具,查看请求头x-api-key,以sk开头",
"WEKNORA_BASE_URL":"http(s)://你的weknora地址/api/v1"
}
}
}
}
```
使用stdio命令直接运行
```
pip install weknora-mcp-server
python -m weknora-mcp-server
```
## 🔧 初始化配置引导
为了方便用户快速配置各类模型,降低试错成本,我们改进了原来的配置文件初始化方式,增加了Web UI界面进行各种模型的配置。在使用之前,请确保代码更新到最新版本。具体使用步骤如下:
如果是第一次使用本项目,可跳过①②步骤,直接进入③④步骤。
### ① 关闭服务
```bash
docker compose down
```
### ② 清空原有数据表(建议在没有重要数据的情况下使用)
```bash
make clean-db
```
### ③ 编译并启动服务
```bash
docker compose up -d --build
```
### ④ 访问Web UI
[http://localhost](http://localhost)
首次访问会自动跳转到注册登录页面,完成注册后,请创建一个新的知识库,并在该知识库的设置页面完成相关设置。
## 📘 文档
+4 -67
View File
@@ -290,16 +290,16 @@ docker compose down
### Web UIインターフェース
<table>
<tr>
<td><b>ナレッジベース管理</b><br/><img src="./docs/images/knowledgebases.png" alt="ナレッジベース管理"></td>
<td><b>対話設定</b><br/><img src="./docs/images/settings.png" alt="対話設定"></td>
</tr>
<tr>
<td colspan="2"><b>インテリジェントQ&A対話</b><br/><img src="./docs/images/qa.png" alt="インテリジェントQ&A対話"></td>
</tr>
<tr>
<td colspan="2"><b>Agentモードツール呼び出しプロセス</b><br/><img src="./docs/images/agent-qa.png" alt="Agentモードツール呼び出しプロセス"></td>
</tr>
<tr>
<td><b>ナレッジベース管理</b><br/><img src="./docs/images/knowledgebases.png" alt="ナレッジベース管理"></td>
<td><b>対話設定</b><br/><img src="./docs/images/settings.png" alt="対話設定"></td>
</tr>
</table>
**ナレッジベース管理:** FAQとドキュメントの2種類のナレッジベースの作成をサポート、ドラッグ&ドロップアップロード、フォルダーインポート、URLインポートなど複数の方法をサポート、文書構造を自動認識してコア知識を抽出し、インデックスを構築します。タグ管理とオンライン入力をサポート、システムは処理の進行状況と文書のステータスを明確に表示し、効率的なナレッジベース管理を実現します。
@@ -327,69 +327,6 @@ WeKnoraは[WeChat対話オープンプラットフォーム](https://chatbot.wei
- **効率的な問題管理**:高頻度の問題の独立した分類管理をサポートし、豊富なデータツールを提供して、正確で信頼性が高く、メンテナンスが容易な回答を保証
- **WeChatエコシステムカバレッジ**:WeChat対話オープンプラットフォームを通じて、WeKnoraのインテリジェントQ&A能力を公式アカウント、ミニプログラムなどのWeChatシナリオにシームレスに統合し、ユーザーインタラクション体験を向上
### 🔗 MCP サーバーを使用してデプロイ済みの WeKnora にアクセス
#### 1️⃣リポジトリのクローン
```
git clone https://github.com/Tencent/WeKnora
```
#### 2️⃣ MCPサーバーの設定
> 設定には直接 [MCP設定説明](./mcp-server/MCP_CONFIG.md) を参照することをお勧めします。
MCPクライアントでサーバーを設定
```json
{
"mcpServers": {
"weknora": {
"args": [
"path/to/WeKnora/mcp-server/run_server.py"
],
"command": "python",
"env":{
"WEKNORA_API_KEY":"WeKnoraインスタンスに入り、開発者ツールを開いて、リクエストヘッダーx-api-keyを確認、skで始まる",
"WEKNORA_BASE_URL":"http(s)://あなたのWeKnoraアドレス/api/v1"
}
}
}
}
```
stdioコマンドで直接実行
```
pip install weknora-mcp-server
python -m weknora-mcp-server
```
## 🔧 初期設定ガイド
ユーザーが各種モデルを素早く設定し、試行錯誤のコストを削減するために、元の設定ファイル初期化方法を改善し、Web UIインターフェースを追加して各種モデルの設定を行えるようにしました。使用前に、コードが最新バージョンに更新されていることを確認してください。具体的な使用手順は以下の通りです:
本プロジェクトを初めて使用する場合は、①②の手順をスキップして、直接③④の手順に進んでください。
### ① サービスの停止
```bash
docker compose down
```
### ② 既存のデータテーブルをクリア(重要なデータがない場合の推奨)
```bash
make clean-db
```
### ③ コンパイルしてサービスを起動
```bash
docker compose up -d --build
```
### ④ Web UIにアクセス
http://localhost
初回アクセス時は自動的に登録・ログインページに遷移します。登録完了後、新規にナレッジベースを作成し、その設定画面で必要な項目を構成してください。
## 📘 ドキュメント
+4 -66
View File
@@ -290,16 +290,16 @@ docker compose down
### Web UI 인터페이스
<table>
<tr>
<td><b>지식베이스 관리</b><br/><img src="./docs/images/knowledgebases.png" alt="지식베이스 관리"></td>
<td><b>대화 설정</b><br/><img src="./docs/images/settings.png" alt="대화 설정"></td>
</tr>
<tr>
<td colspan="2"><b>지능형 Q&A 대화</b><br/><img src="./docs/images/qa.png" alt="지능형 Q&A 대화"></td>
</tr>
<tr>
<td colspan="2"><b>Agent 모드 도구 호출 과정</b><br/><img src="./docs/images/agent-qa.png" alt="Agent 모드 도구 호출 과정"></td>
</tr>
<tr>
<td><b>지식베이스 관리</b><br/><img src="./docs/images/knowledgebases.png" alt="지식베이스 관리"></td>
<td><b>대화 설정</b><br/><img src="./docs/images/settings.png" alt="대화 설정"></td>
</tr>
</table>
**지식베이스 관리:** FAQ/문서 지식베이스 타입 생성 지원, 드래그 앤 드롭/폴더/URL 임포트 등 다양한 방식 지원. 문서 구조를 자동 식별하고 핵심 지식을 추출해 인덱스를 구축합니다. 태그 관리와 온라인 입력을 지원하며, 처리 진행 상황과 문서 상태를 명확히 표시해 효율적인 지식베이스 운영을 돕습니다.
@@ -326,68 +326,6 @@ WeKnora는 [WeChat 대화 오픈 플랫폼](https://chatbot.weixin.qq.com)의
- **효율적인 질문 관리**: 고빈도 질문의 분류 관리 지원, 풍부한 데이터 도구를 통해 정확하고 신뢰할 수 있으며 유지보수하기 쉬운 답변 제공
- **WeChat 생태계 통합**: WeChat 공식계정, 미니프로그램 등 다양한 시나리오에 WeKnora의 Q&A 역량을 자연스럽게 통합
### 🔗 MCP 서버로 WeKnora 접속
#### 1️⃣ 저장소 클론
```
git clone https://github.com/Tencent/WeKnora
```
#### 2️⃣ MCP 서버 설정
> 설정은 [MCP 설정 가이드](./mcp-server/MCP_CONFIG.md)를 직접 참고하는 것을 권장합니다.
MCP 클라이언트에서 서버 연결을 설정합니다:
```json
{
"mcpServers": {
"weknora": {
"args": [
"path/to/WeKnora/mcp-server/run_server.py"
],
"command": "python",
"env":{
"WEKNORA_API_KEY":"WeKnora 인스턴스에서 개발자 도구를 열고, sk로 시작하는 요청 헤더 x-api-key를 확인",
"WEKNORA_BASE_URL":"http(s)://your-weknora-address/api/v1"
}
}
}
}
```
stdio 명령으로 직접 실행:
```
pip install weknora-mcp-server
python -m weknora-mcp-server
```
## 🔧 초기 설정 가이드
사용자가 다양한 모델을 빠르게 설정하고 시행착오 비용을 줄일 수 있도록, 기존 설정 파일 초기화 방식을 개선하고 Web UI 기반 설정 인터페이스를 추가했습니다. 사용 전에 코드가 최신 버전인지 확인하세요. 절차는 아래와 같습니다.
프로젝트를 처음 사용하는 경우 ①② 단계를 건너뛰고 ③④로 바로 진행해도 됩니다.
### ① 서비스 중지
```bash
docker compose down
```
### ② 기존 데이터 테이블 정리(중요 데이터가 없을 때 권장)
```bash
make clean-db
```
### ③ 컴파일 및 서비스 시작
```bash
docker compose up -d --build
```
### ④ Web UI 접속
http://localhost
처음 접속하면 자동으로 회원가입/로그인 페이지로 이동합니다. 가입 완료 후 새 지식베이스를 생성하고 설정 페이지에서 필요한 항목을 구성하세요.
## 📘 API 레퍼런스