Skip to content

Commit cb72b37

Browse files
authored
doc:补充mcp server应用配置指导 (#1012)
1 parent df09353 commit cb72b37

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

README.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -190,6 +190,33 @@ docker run -p 8181:8181 --name mindoc -e DB_ADAPTER=mysql -e MYSQL_PORT_3306_TCP
190190
>
191191
> 更多 docker-compose 的使用相关的内容 请查看官网文档或百度
192192
193+
#### MCP服务器对接指导
194+
1. 请在配置文件中启用MCP服务器功能
195+
在配置文件`app.conf`中添加或修改为如下内容:
196+
```
197+
# MCP Server 功能
198+
enable_mcp_server="${MINDOC_ENABLE_MCP_SERVER||true}"
199+
mcp_api_key="${MINDOC_MCP_API_KEY||demo-mcp-api-key}"
200+
```
201+
说明:
202+
`enable_mcp_server`为是否启用MCP服务器功能,默认为true。
203+
`mcp_api_key` 为MCP服务器的API密钥,示例配置中默认为`demo-mcp-api-key`,可根据需求自行修改。
204+
205+
2. 在Dify等AI应用或其他可调用MCP服务器的项目配置中添加如下Mindoc配置
206+
```json
207+
{
208+
"mindoc": {
209+
"transport": "streamable_http",
210+
"url": "http://127.0.0.1:8181/mcp/?api_key=demo-mcp-api-key",
211+
"headers":{},
212+
"timeout":600
213+
}
214+
}
215+
```
216+
说明:
217+
`transport`为传输方式,目前支持`streamable_http`
218+
`url`为Mindoc的MCP服务地址,示例配置中Endpoint默认为`http://127.0.0.1:8181`,默认的API密钥为`demo-mcp-api-key`,可自行修改为对接时项目实际使用的Endpoint和API密钥。
219+
193220
# 项目截图
194221

195222
**创建项目**

0 commit comments

Comments
 (0)