返回 MCP 目录
public公开dns本地运行

mcp-web-ui

MCP Web UI是一个基于Model Context Protocol的网页界面,提供多LLM供应商集成、实时聊天流、上下文管理和配置管理功能。

article

README

🚀 MCP Web 网页项目

MCP Web 网页项目基于模型上下文协议(Model Context Protocol),打造了一个用户友好的网页应用。它能让用户轻松与各类机器学习模型和服务展开交互,极大提升了使用体验。

🚀 快速开始

MCP Web 网页项目是一个强大的基于模型上下文协议的网页应用。在开始使用前,请确保满足先决条件,然后按照安装指南完成项目的安装与启动。

✨ 主要特性

  • 多模型支持:集成多种不同的机器学习模型和服务器。
  • 灵活配置:通过 YAML 格式的配置文件,轻松管理不同模型的服务参数。
  • 日志记录:提供详细的日志记录功能,便于调试和监控系统运行状态。
  • 扩展性好:支持自定义扩展,允许用户添加新的模型和服务。

📦 安装指南

先决条件

  1. 安装 Go 语言环境(版本 1.20 或以上)。
  2. 确保已安装 Node.js 和 npm,用于构建静态资源。
  3. 安装 Docker 和 Docker Compose,用于容器化部署。

安装步骤

下载代码

使用 Git 克隆项目仓库:

git clone https://github.com/yourusername/mcp-web.git
cd mcp-web

依赖管理

安装项目所需的 Go 模块:

go mod tidy

构建项目

运行以下命令构建可执行文件:

go build -o mcp-web .

启动应用

启动 MCP Web 网页项目的命令如下:

./mcp-web --config ./configs/default.yaml

默认配置文件位于 configs/default.yaml

📚 详细文档

配置文件说明

项目的配置文件使用 YAML 格式,主要包含以下内容:

核心配置

  • 端口设置:指定应用运行的监听端口。
    port: 8080
    
  • 日志级别:控制输出的日志详细程度。
    logLevel: info
    

模型服务配置

主模型配置
llm:
  provider: anthropic  # 可选值:anthropic, openai, custom
  model: claude-3-5-sonnet-20241022
  parameters:
    temperature: 0.7
标题生成配置
genTitleLLM:
  provider: openai
  model: gpt-3.5-turbo

MCP 服务器配置

SSE 服务器配置
mcpSSEServers:
  filesystem:
    url: https://yoursseserver.com
    maxPayloadSize: 1048576 # 单位:字节,默认为1MB
标准输入输出服务器配置
mcpStdIOServers:
  filesystem:
    command: npx
    args:
      - -y
      - "@modelcontextprotocol/server-filesystem"
      - "/path/to/your/files"

示例配置文件

port: 8080
logLevel: info

llm:
  provider: anthropic
  model: claude-3-5-sonnet-20241022
  parameters:
    temperature: 0.7

genTitleLLM:
  provider: openai
  model: gpt-3.5-turbo

项目结构

mcp-web/
├── cmd/               # 应用入口文件
├── internal/         # 核心业务逻辑包
│   ├── handlers/     # Web 请求处理函数
│   ├── models/       # 数据模型定义
│   └── services/     # 第三方服务集成(如模型接口)
├── static/           # 静态资源文件(CSS、JS 等)
└── templates/        # HTML 模板文件

贡献指南

  1. ** Fork 项目仓库。
  2. 在你的分支上进行代码修改。
  3. 提交并推送修改内容。
  4. 创建 Pull Request 提交到主分支。

📄 许可证

本项目遵循 MIT 许可证协议。

help

运行方式说明

cloud

托管运行

托管运行通常表示这个 MCP Server 由服务方环境承载,用户一般按页面提供的连接方式或授权流程接入,不需要在本地长期启动一个 MCP 进程

  1. 打开服务方连接页
  2. 完成授权或复制端点
  3. 在 MCP 客户端中连接
terminal

本地运行 / 其它方式

本地运行通常需要用户在自己的电脑或服务器上安装依赖,把 server_config 复制到 MCP 客户端,并按 env_schema 补齐环境变量、密钥或其它配置

  1. 复制 server_config
  2. 安装所需依赖
  3. 补齐环境变量后重启客户端