diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts index e7dcf33f..630aacb3 100644 --- a/docs/.vitepress/config.mts +++ b/docs/.vitepress/config.mts @@ -153,6 +153,10 @@ export default defineConfig({ text: "使用知识库", link: "/zh/deploy/knowledge/readme", }, + { + text: "使用 MCP 服务", + link: "zh/deploy/mcp/readme" + }, { text: "系统环境设置", link: "/zh/deploy/settings", @@ -211,10 +215,6 @@ export default defineConfig({ text: "如何实现一个消息平台适配器？", link: "/zh/workshop/impl-platform-adapter", }, - { - text: "在 LangBot 接入完整 MCP 生态", - link: "/zh/workshop/mcp-details" - }, { text: "容器网络配置详解", link: "/zh/workshop/network-details", @@ -406,6 +406,10 @@ export default defineConfig({ text: "Using Knowledge Base", link: "/en/deploy/knowledge/readme", }, + { + text: "Using MCP Services", + link: "/en/deploy/mcp/readme", + }, { text: "System Settings", link: "/en/deploy/settings", @@ -463,13 +467,13 @@ export default defineConfig({ text: "How to Implement a Message Platform Adapter?", link: "/en/workshop/impl-platform-adapter", }, + // { + // text: "Integrating Complete MCP Ecosystem in LangBot", + // link: "/en/workshop/mcp-details" + // }, { - text: "Integrating Complete MCP Ecosystem in LangBot", - link: "/en/workshop/mcp-details" - }, - { - text: "Container Network Configuration Details", - link: "/en/workshop/network-details", + text: "Container Network Configuration Details", + link: "/en/workshop/network-details", }, { text: "Using New API to Transmit Models from Multiple Channels", diff --git a/docs/assets/image/zh/deploy/mcp/mcp02.png b/docs/assets/image/zh/deploy/mcp/mcp02.png new file mode 100644 index 00000000..cfaa66d8 Binary files /dev/null and b/docs/assets/image/zh/deploy/mcp/mcp02.png differ diff --git a/docs/assets/image/zh/deploy/mcp/mcp03.png b/docs/assets/image/zh/deploy/mcp/mcp03.png new file mode 100644 index 00000000..59025af1 Binary files /dev/null and b/docs/assets/image/zh/deploy/mcp/mcp03.png differ diff --git a/docs/assets/image/zh/deploy/mcp/mcp04.png b/docs/assets/image/zh/deploy/mcp/mcp04.png new file mode 100644 index 00000000..3d088ee9 Binary files /dev/null and b/docs/assets/image/zh/deploy/mcp/mcp04.png differ diff --git a/docs/assets/image/zh/deploy/mcp/mcp05.png b/docs/assets/image/zh/deploy/mcp/mcp05.png new file mode 100644 index 00000000..b8f607b5 Binary files /dev/null and b/docs/assets/image/zh/deploy/mcp/mcp05.png differ diff --git a/docs/assets/image/zh/deploy/mcp/mcp_01.png b/docs/assets/image/zh/deploy/mcp/mcp_01.png new file mode 100644 index 00000000..5b062add Binary files /dev/null and b/docs/assets/image/zh/deploy/mcp/mcp_01.png differ diff --git a/docs/en/deploy/mcp/readme.md b/docs/en/deploy/mcp/readme.md new file mode 100644 index 00000000..b54c76d0 --- /dev/null +++ b/docs/en/deploy/mcp/readme.md @@ -0,0 +1,37 @@ +# Using MCP Servers + + +LangBot supports SSE mode MCP servers. You can add MCP servers to leverage the tool calling capabilities in large language models for better handling of LLM requests. + +:::info +MCP service only supports SSE mode. +- MCP servers recommended acquisition channel: [Composio MCP](https://mcp.composio.dev/) +::: + +## Enable Function Calling for Models + +As shown in the image, enable the `Function Calling` feature for the model. + +enable function call + +## Create MCP Server + +Click `Plugin Management`, then `MCP Management`, as shown: + +server page + +Click `Add` in the top right corner, then `Create MCP Server`, + +create new mcp server + +For example, to use the Fetch HTML server, fill in the corresponding URL, click `Test` to test the MCP server, and click `Submit` to add the server. + +After adding, click the switch on the card to connect to the MCP server. Click the card to view the MCP server details: + +detailed server + +## Effect + +You need to select `Local Agent` as the runner in the pipeline settings and use a model that supports function calling. + +dialog with mcp diff --git a/docs/en/deploy/settings.md b/docs/en/deploy/settings.md index d10ce6b5..49d66398 100644 --- a/docs/en/deploy/settings.md +++ b/docs/en/deploy/settings.md @@ -34,47 +34,6 @@ concurrency: # Single session concurrency session: 1 -# MCP configuration -# Should be configurable in WebUI in the future -mcp: - # MCP server list - # Currently supports two protocol MCP servers: - # - SSE - # - Stdio (Python) - # - # Format: - # SSE mode: - # name Server name, self-defined - # enable Whether to enable this Server - # mode Fixed as sse - # url MCP SSE Server access URL - # headers Connection headers, optional - # timeout Connection timeout - # - # stdio mode: - # name Server name, self-defined - # enable Whether to enable this Server - # mode Fixed as stdio - # command Execution command - # args Command parameters - # env Command environment variables, optional - # - # For example: - # servers: - # - name: 'SSE Server' - # enable: true - # mode: sse - # url: 'http://127.0.0.1:8000/sse' - # headers: {} - # timeout: 10 - # - name: 'stdio Server' - # enable: true - # mode: stdio - # command: 'python' - # args: ['-m', 'weather'] - # env: {} - servers: [] - # Proxy configuration proxy: # HTTP proxy address diff --git a/docs/en/workshop/mcp-details.md b/docs/en/workshop/mcp-details.md index 2acc1839..872085d7 100644 --- a/docs/en/workshop/mcp-details.md +++ b/docs/en/workshop/mcp-details.md @@ -20,6 +20,6 @@ There are two types of MCP Servers in the market: ## Configuring MCP Server -Please refer to the [System Settings Documentation](/zh/deploy/settings.html) +Please refer to the [System Settings Documentation](/en/deploy/settings.html) After configuration, you can use the `!func` command in chat to view registered MCP tools. When chatting with models that support Function Calling, LangBot will automatically call MCP tools. \ No newline at end of file diff --git a/docs/zh/deploy/mcp/readme.md b/docs/zh/deploy/mcp/readme.md new file mode 100644 index 00000000..f3952943 --- /dev/null +++ b/docs/zh/deploy/mcp/readme.md @@ -0,0 +1,49 @@ +# 使用MCP服务器 + + +LangBot 支持 SSE 模式 MCP 服务器，您可以添加 MCP 服务器，使用大语言模型中的工具调用特性，更好的处理 LLM 请求。 + +:::info +- MCP 服务仅支持 SSE 模式。 +- MCP 服务器推荐获取渠道：[ModelScope](https://modelscope.cn/mcp) +::: + +## 打开模型的函数调用功能 + +如图，将模型的`函数调用`功能打开。 + +enable function call + +## 创建MCP服务器 + +点击`插件管理` -> `MCP管理`，如图所示： + +server page + +点击右上角的`添加`，选择`添加 MCP 服务器`， + +create new mcp server + +比如使用 Fetch HTML 服务器，填写对应的 URL，点击`测试`用来测试 MCP 服务器，点`提交`添加此服务器。 + +添加完成之后，点击卡片上的开关以连接 MCP 服务器，点击卡片可以看到 MCP 服务器的详情： + +detailed server + +## 效果 + +需要在流水线设置中选用 `内置 Agent` 作为运行器，并使用支持函数调用的模型。 + +dialog with mcp + + + + + + + + + + + + diff --git a/docs/zh/deploy/settings.md b/docs/zh/deploy/settings.md index d0943a75..43e4200b 100644 --- a/docs/zh/deploy/settings.md +++ b/docs/zh/deploy/settings.md @@ -34,47 +34,6 @@ concurrency: # 单会话并发数 session: 1 -# MCP 配置 -# 后续应该会改为在 WebUI 上可以配置 -mcp: - # MCP 服务器列表 - # 目前支持两种协议的 MCP 服务器： - # - SSE - # - Stdio（Python） - # - # 格式： - # SSE 模式： - # name 服务器名称，自行定义 - # enable 是否启用本 Server - # mode 固定填写 sse - # url MCP SSE Server 的访问 URL - # headers 连接时的 headers，可选 - # timeout 连接超时时间 - # - # stdio 模式： - # name 服务器名称，自行定义 - # enable 是否启用本 Server - # mode 固定填写 stdio - # command 执行命令 - # args 执行命令的参数 - # env 执行命令的环境变量，可选 - # - # 例如： - # servers: - # - name: 'SSE Server' - # enable: true - # mode: sse - # url: 'http://127.0.0.1:8000/sse' - # headers: {} - # timeout: 10 - # - name: 'stdio Server' - # enable: true - # mode: stdio - # command: 'python' - # args: ['-m', 'weather'] - # env: {} - servers: [] - # 代理配置 proxy: # HTTP 代理地址