mirror of https://github.com/Mai-with-u/MaiBot.git
335 lines
12 KiB
TOML
335 lines
12 KiB
TOML
# MCP桥接插件 v1.7.0 - 配置文件示例
|
||
# 将 MCP (Model Context Protocol) 服务器的工具桥接到 MaiBot
|
||
#
|
||
# 使用方法：复制此文件为 config.toml，然后根据需要修改配置
|
||
#
|
||
# ============================================================
|
||
# 🎯 快速开始（三步）
|
||
# ============================================================
|
||
# 1. 在下方 [servers] 添加 MCP 服务器配置
|
||
# 2. 将 enabled 改为 true 启用服务器
|
||
# 3. 重启 MaiBot 或发送 /mcp reconnect
|
||
#
|
||
# ============================================================
|
||
# 📚 去哪找 MCP 服务器？
|
||
# ============================================================
|
||
#
|
||
# 【远程服务（推荐新手）】
|
||
# - ModelScope: https://mcp.modelscope.cn/ (免费，推荐)
|
||
# - Smithery: https://smithery.ai/
|
||
# - Glama: https://glama.ai/mcp/servers
|
||
#
|
||
# 【本地服务（需要 npx 或 uvx）】
|
||
# - 官方列表: https://github.com/modelcontextprotocol/servers
|
||
#
|
||
# ============================================================
|
||
|
||
# ============================================================
|
||
# 插件基本信息
|
||
# ============================================================
|
||
[plugin]
|
||
name = "mcp_bridge_plugin"
|
||
version = "1.7.0"
|
||
config_version = "1.7.0"
|
||
enabled = false # 默认禁用，在 WebUI 中启用
|
||
|
||
# ============================================================
|
||
# 🆕 v1.5.4 快速入门（只读，WebUI 显示）
|
||
# ============================================================
|
||
[guide]
|
||
# 🚀 快速入门 - 三步开始使用
|
||
quick_start = "1. 从下方链接获取 MCP 服务器 2. 在「快速添加」填写信息 3. 保存后发送 /mcp reconnect"
|
||
|
||
# 🌐 获取 MCP 服务器 - 复制链接到浏览器打开，获取免费 MCP 服务器
|
||
# 魔搭 ModelScope 国内免费推荐，复制服务器 URL 到「快速添加」即可
|
||
mcp_sources = "https://modelscope.cn/mcp (魔搭·推荐) | https://smithery.ai | https://glama.ai | https://mcp.so"
|
||
|
||
# 📝 配置示例 - 复制到服务器列表可直接使用（免费时间服务器）
|
||
example_config = '{"name": "time", "enabled": true, "transport": "streamable_http", "url": "https://mcp.api-inference.modelscope.cn/server/mcp-server-time"}'
|
||
|
||
# ============================================================
|
||
# 全局设置
|
||
# ============================================================
|
||
[settings]
|
||
# 🏷️ 工具前缀 - 用于区分 MCP 工具和原生工具
|
||
tool_prefix = "mcp"
|
||
|
||
# ⏱️ 连接超时（秒）
|
||
connect_timeout = 30.0
|
||
|
||
# ⏱️ 调用超时（秒）
|
||
call_timeout = 60.0
|
||
|
||
# 🔄 自动连接 - 启动时自动连接所有已启用的服务器
|
||
auto_connect = true
|
||
|
||
# 🔁 重试次数 - 连接失败时的重试次数
|
||
retry_attempts = 3
|
||
|
||
# ⏳ 重试间隔（秒）
|
||
retry_interval = 5.0
|
||
|
||
# 💓 心跳检测 - 定期检测服务器连接状态
|
||
heartbeat_enabled = true
|
||
|
||
# 💓 心跳间隔（秒）- 建议 30-120 秒
|
||
heartbeat_interval = 60.0
|
||
|
||
# 🧠 智能心跳 - 根据服务器稳定性自动调整心跳间隔（v1.5.2）
|
||
# 稳定服务器逐渐增加间隔，断开的服务器缩短间隔
|
||
heartbeat_adaptive = true
|
||
|
||
# 📈 最大间隔倍数 - 稳定服务器心跳间隔最高可达 基准间隔 × 此值（v1.5.3）
|
||
heartbeat_max_multiplier = 3.0
|
||
|
||
# 🔄 自动重连 - 检测到断开时自动尝试重连
|
||
auto_reconnect = true
|
||
|
||
# 🔄 最大重连次数 - 连续重连失败后暂停重连
|
||
max_reconnect_attempts = 3
|
||
|
||
# ============================================================
|
||
# v1.7.0 状态实时刷新
|
||
# ============================================================
|
||
# 📊 启用状态实时刷新 - 定期更新 WebUI 状态显示
|
||
status_refresh_enabled = true
|
||
|
||
# 📊 状态刷新间隔（秒）- 值越小刷新越频繁，但会增加少量磁盘写入
|
||
status_refresh_interval = 10.0
|
||
|
||
# ============================================================
|
||
# v1.2.0 高级功能（实验性）
|
||
# ============================================================
|
||
# 📦 启用 Resources - 允许读取 MCP 服务器提供的资源
|
||
enable_resources = false
|
||
|
||
# 📝 启用 Prompts - 允许使用 MCP 服务器提供的提示模板
|
||
enable_prompts = false
|
||
|
||
# ============================================================
|
||
# v1.3.0 结果后处理功能
|
||
# ============================================================
|
||
# 当 MCP 工具返回的内容过长时，使用 LLM 对结果进行摘要提炼
|
||
|
||
# 🔄 启用结果后处理
|
||
post_process_enabled = false
|
||
|
||
# 📏 后处理阈值（字符数）- 结果长度超过此值才触发后处理
|
||
post_process_threshold = 500
|
||
|
||
# <20> 后处理输e出限制 - LLM 摘要输出的最大 token 数
|
||
post_process_max_tokens = 500
|
||
|
||
# 🤖 后处理模型（可选）- 留空则使用 utils 模型组
|
||
post_process_model = ""
|
||
|
||
# <20> 后处理提示词模板-
|
||
post_process_prompt = '''用户问题：{query}
|
||
|
||
工具返回内容：
|
||
{result}
|
||
|
||
请从上述内容中提取与用户问题最相关的关键信息，简洁准确地输出：'''
|
||
|
||
# ============================================================
|
||
# 🆕 v1.4.0 调用链路追踪
|
||
# ============================================================
|
||
# 记录工具调用详情，便于调试和分析
|
||
|
||
# 🔍 启用调用追踪
|
||
trace_enabled = true
|
||
|
||
# 📊 追踪记录上限 - 内存中保留的最大记录数
|
||
trace_max_records = 100
|
||
|
||
# 📝 追踪日志文件 - 是否将追踪记录写入日志文件
|
||
# 启用后记录写入 plugins/MaiBot_MCPBridgePlugin/logs/trace.jsonl
|
||
trace_log_enabled = false
|
||
|
||
# ============================================================
|
||
# 🆕 v1.4.0 工具调用缓存
|
||
# ============================================================
|
||
# 缓存相同参数的调用结果，减少重复请求
|
||
|
||
# 🗄️ 启用调用缓存
|
||
cache_enabled = false
|
||
|
||
# ⏱️ 缓存有效期（秒）
|
||
cache_ttl = 300
|
||
|
||
# 📦 最大缓存条目 - 超出后 LRU 淘汰
|
||
cache_max_entries = 200
|
||
|
||
# <20> 缓存排除列表 - 即不缓存的工具（每行一个，支持通配符 *）
|
||
# 时间类、随机类工具建议排除
|
||
cache_exclude_tools = '''
|
||
mcp_*_time_*
|
||
mcp_*_random_*
|
||
'''
|
||
|
||
# ============================================================
|
||
# 🆕 v1.4.0 工具管理
|
||
# ============================================================
|
||
[tools]
|
||
# 📋 工具清单（只读）- 启动后自动生成
|
||
tool_list = "(启动后自动生成)"
|
||
|
||
# 🚫 禁用工具列表 - 要禁用的工具名（每行一个）
|
||
# 从上方工具清单复制工具名，禁用后该工具不会被 LLM 调用
|
||
# 示例：
|
||
# disabled_tools = '''
|
||
# mcp_filesystem_delete_file
|
||
# mcp_filesystem_write_file
|
||
# '''
|
||
disabled_tools = ""
|
||
|
||
# ============================================================
|
||
# 🆕 v1.5.1 快速添加服务器
|
||
# ============================================================
|
||
# 表单式配置，无需手写 JSON
|
||
[quick_add]
|
||
# 📛 服务器名称 - 服务器唯一名称（英文，如 time-server）
|
||
server_name = ""
|
||
|
||
# 📡 传输类型 - 远程服务器选 streamable_http/http/sse，本地选 stdio
|
||
server_type = "streamable_http"
|
||
|
||
# 🌐 服务器 URL - 远程服务器必填（streamable_http/http/sse 类型）
|
||
server_url = ""
|
||
|
||
# ⌨️ 启动命令 - stdio 类型必填（如 uvx、npx、python）
|
||
server_command = ""
|
||
|
||
# 📝 命令参数 - stdio 类型使用，每行一个参数
|
||
server_args = ""
|
||
|
||
# 🔑 鉴权头（可选）- JSON 格式，如 {"Authorization": "Bearer xxx"}
|
||
server_headers = ""
|
||
|
||
# ============================================================
|
||
# 🆕 v1.6.0 配置导入导出
|
||
# ============================================================
|
||
# 支持从 Claude Desktop / Kiro / MaiBot 格式导入导出
|
||
[import_export]
|
||
# 📥 导入配置 - 粘贴 Claude Desktop 或其他格式的 MCP 配置 JSON
|
||
# 粘贴配置后点击保存，2秒内自动导入。查看下方「导入结果」确认状态
|
||
import_config = ""
|
||
|
||
# 📋 导入结果（只读）- 显示导入操作的结果
|
||
import_result = ""
|
||
|
||
# 📤 导出格式 - claude: Claude Desktop 格式 | kiro: Kiro MCP 格式 | maibot: 本插件格式
|
||
export_format = "claude"
|
||
|
||
# 📤 导出结果（只读，可复制）- 点击保存后生成，可复制到 Claude Desktop 或其他支持 MCP 的应用
|
||
export_result = "(点击保存后生成)"
|
||
|
||
# ============================================================
|
||
# 🆕 v1.4.0 权限控制
|
||
# ============================================================
|
||
[permissions]
|
||
# 🔐 启用权限控制 - 按群/用户限制工具使用
|
||
perm_enabled = false
|
||
|
||
# 📋 默认模式
|
||
# allow_all: 未配置规则的工具默认允许
|
||
# deny_all: 未配置规则的工具默认禁止
|
||
perm_default_mode = "allow_all"
|
||
|
||
# ────────────────────────────────────────────────────────────
|
||
# 🚀 快捷配置（推荐新手使用）
|
||
# ────────────────────────────────────────────────────────────
|
||
|
||
# 🚫 禁用群列表 - 这些群无法使用任何 MCP 工具（每行一个群号）
|
||
# 示例：
|
||
# quick_deny_groups = '''
|
||
# 123456789
|
||
# 987654321
|
||
# '''
|
||
quick_deny_groups = ""
|
||
|
||
# ✅ 管理员白名单 - 这些用户始终可以使用所有工具（每行一个QQ号）
|
||
# 示例：
|
||
# quick_allow_users = '''
|
||
# 111111111
|
||
# '''
|
||
quick_allow_users = ""
|
||
|
||
# ────────────────────────────────────────────────────────────
|
||
# 📜 高级权限规则（可选，针对特定工具配置）
|
||
# ────────────────────────────────────────────────────────────
|
||
# 格式: qq:ID:group/private/user，工具名支持通配符 *
|
||
# 示例：
|
||
# perm_rules = '''
|
||
# [
|
||
# {"tool": "mcp_*_delete_*", "denied": ["qq:123456:group"]}
|
||
# ]
|
||
# '''
|
||
perm_rules = "[]"
|
||
|
||
# ============================================================
|
||
# 🔌 MCP 服务器配置
|
||
# ============================================================
|
||
#
|
||
# ⚠️ 重要：JSON 格式说明
|
||
# ────────────────────────────────────────────────────────────
|
||
# 服务器列表必须是 JSON 数组格式！
|
||
#
|
||
# ❌ 错误写法：
|
||
# { "name": "server1", ... },
|
||
# { "name": "server2", ... }
|
||
#
|
||
# ✅ 正确写法：
|
||
# [
|
||
# { "name": "server1", ... },
|
||
# { "name": "server2", ... }
|
||
# ]
|
||
#
|
||
# ────────────────────────────────────────────────────────────
|
||
# 每个服务器的配置字段：
|
||
# name - 服务器名称（唯一标识）
|
||
# enabled - 是否启用 (true/false)
|
||
# transport - 传输方式: "stdio" / "sse" / "http" / "streamable_http"
|
||
# url - 服务器地址（sse/http/streamable_http 模式必填）
|
||
# headers - 🆕 鉴权头（可选，如 {"Authorization": "Bearer xxx"}）
|
||
# command - 启动命令（stdio 模式，如 "npx" 或 "uvx"）
|
||
# args - 命令参数数组（stdio 模式）
|
||
# env - 环境变量对象（stdio 模式，可选）
|
||
# post_process - 服务器级别后处理配置（可选）
|
||
#
|
||
# ============================================================
|
||
|
||
[servers]
|
||
list = '''
|
||
[
|
||
{
|
||
"name": "time-mcp-server",
|
||
"enabled": false,
|
||
"transport": "streamable_http",
|
||
"url": "https://mcp.api-inference.modelscope.cn/server/mcp-server-time"
|
||
},
|
||
{
|
||
"name": "my-auth-server",
|
||
"enabled": false,
|
||
"transport": "streamable_http",
|
||
"url": "https://mcp.api-inference.modelscope.net/xxxxxx/mcp",
|
||
"headers": {
|
||
"Authorization": "Bearer ms-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
|
||
}
|
||
},
|
||
{
|
||
"name": "fetch-local",
|
||
"enabled": false,
|
||
"transport": "stdio",
|
||
"command": "uvx",
|
||
"args": ["mcp-server-fetch"]
|
||
}
|
||
]
|
||
'''
|
||
|
||
# ============================================================
|
||
# 状态显示（只读）
|
||
# ============================================================
|
||
[status]
|
||
connection_status = "未初始化"
|