Files
prompt-optimizer/env.local.example
T
linshen 1a55a5e719 feat(server): 集成 MCP 服务器
本次提交主要集成了 MCP 服务器,为系统增加了用户提示词优化工具,并通过优化部署流程,提升了整体易用性。

具体变更内容包括:

* **功能增强:**
    * 集成 MCP 服务器,提供用户和系统提示词优化工具,支持 stdio 和 HTTP 两种传输方式,并集成了 Claude Desktop。
    * 实现基于会话的 HTTP 传输,允许多客户端连接,并为每个会话创建独立的 MCP 服务器实例,确保会话间的隔离性。

* **部署优化:**
    * 将 MCP 服务器端口变更为与 Web 界面共享 80 端口,通过路径区分,简化了 Docker 部署配置,降低了部署复杂度。
    * 优化 Docker 部署流程,使用 Supervisor 进行进程管理,并改进模板参数(使用枚举类型 + 默认值),同时提供了包含 MCP 服务器使用说明的 Docker 部署文档。

* **代码优化与重构:**
    * 优化模型选择逻辑,提高模型选择的准确性。
    * 优化日志记录功能,支持更灵活的日志级别设置,并添加了详细的错误提示和调试信息,方便问题排查。
    * 重构代码,分离构建和启动入口,优化环境变量加载和模型初始化逻辑,提高了代码的可维护性和可扩展性,并解决了构建副作用问题。

* **文档更新:**
    * 更新工具描述和使用说明,提供了用户和系统提示词工具的具体示例,并补充了迭代提示词工具的改进需求描述和使用场景。
    * 更新 Docker 部署方案,包含了 `docker-compose.yml`、`Dockerfile` 和 `env.local.example` 配置示例,并更新了 README 文档以明确连接方式。
    * 更新 `nginx.conf`,使用环境变量 `NGINX_PORT`,修改 `start-services.sh`,增加 nginx 配置处理,更新 `supervisord.conf`,调整 MCP 服务器启动方式,优化 `Dockerfile`,安装额外依赖并调整工作目录,调整环境变量加载机制,使用 `preload-env.cjs`。

* **其他:**
    * 提供快速开始指南、环境变量配置和问题排除等文档,更新了相关文档链接和获取帮助指引,并完成了基础测试用例和开发/设计文档。

本次更新旨在提升用户在提示词优化方面的能力,并简化部署流程,提高系统的整体可用性和可维护性。
2025-07-27 00:31:23 +08:00

96 lines
3.4 KiB
Plaintext
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# 环境变量配置示例文件
# 将此文件复制为 .env.local 并填入你的实际配置
# ===== LLM API 密钥配置 =====
# 配置您要使用的 LLM 服务的 API 密钥
# 不同模块会根据需要使用这些配置
# OpenAI API 配置
# VITE_OPENAI_API_KEY=sk-your-openai-api-key-here
# Google Gemini API 配置
# VITE_GEMINI_API_KEY=your-gemini-api-key-here
# DeepSeek API 配置
# VITE_DEEPSEEK_API_KEY=sk-your-deepseek-api-key-here
# 智谱 AI API 配置
# VITE_ZHIPU_API_KEY=your-zhipu-api-key-here
# SiliconFlow API 配置
# VITE_SILICONFLOW_API_KEY=sk-your-siliconflow-api-key-here
# 自定义 API 配置(如 Ollama 本地服务)
# VITE_CUSTOM_API_KEY=your-custom-api-key
# VITE_CUSTOM_API_BASE_URL=http://localhost:11434/v1
# VITE_CUSTOM_API_MODEL=qwen2.5:0.5b
# ===== MCP 服务器配置 =====
# 以下配置仅在使用 MCP 服务器时需要
# 首选模型提供商(当配置了多个 API 密钥时)
# 可选值:openai, gemini, deepseek, siliconflow, zhipu, custom
# 注意:必须与上面配置的 API 密钥对应
# MCP_DEFAULT_MODEL_PROVIDER=openai
# HTTP 服务器端口(默认 3000)
# MCP_HTTP_PORT=3000
# 日志级别(默认 debug)
# 可选值:debug, info, warn, error
# MCP_LOG_LEVEL=debug
# 默认语言(默认 zh)
# 可选值:zh, en
# MCP_DEFAULT_LANGUAGE=zh
# ===== Docker 部署访问控制配置 =====
# 以下配置仅在 Docker 部署时需要,用于设置 Web 界面的访问控制
# 访问用户名(可选,默认为 admin)
# ACCESS_USERNAME=admin
# 访问密码(可选,不设置则无密码保护)
# ACCESS_PASSWORD=your_password
# ===== 开发环境更新测试配置 =====
# 取消注释以下配置来启用开发环境的更新测试功能
# 方式1:使用 GITHUB_REPOSITORY 环境变量(推荐)
# GITHUB_REPOSITORY=your-username/your-repo-name
# 方式2:分别设置仓库所有者和名称
# DEV_REPO_OWNER=your-username
# DEV_REPO_NAME=your-repo-name
# ===== 使用说明 =====
#
# LLM API 密钥:
# 1. 使用 VITE_ 前缀的环境变量,支持所有模块(Web、Desktop、MCP 服务器等)
# 2. 根据使用的功能配置相应的 API 密钥
# 3. 自定义 API 支持本地服务(如 Ollama)和其他兼容 OpenAI 格式的服务
#
# MCP 服务器(仅在使用 MCP 功能时需要):
# 1. 需要至少配置一个 API 密钥才能启动
# 2. 在项目根目录执行 pnpm mcp:dev 启动开发服务器
# 3. 如果配置多个 API 密钥,可通过 MCP_DEFAULT_MODEL_PROVIDER 指定首选
# 4. MCP_DEFAULT_MODEL_PROVIDER 支持的值:
# - openai: 使用 OpenAI GPT 模型
# - gemini: 使用 Google Gemini 模型
# - deepseek: 使用 DeepSeek 模型
# - siliconflow: 使用 SiliconFlow 模型
# - zhipu: 使用智谱 AI 模型
# - custom: 使用自定义 API(如 Ollama 等)
# 5. HTTP 模式默认端口 3000,可通过 MCP_HTTP_PORT 修改
# 6. 默认启用 debug 日志,可通过 MCP_LOG_LEVEL 调整
#
# Docker 部署访问控制:
# 1. ACCESS_USERNAME 和 ACCESS_PASSWORD 仅在 Docker 部署时使用
# 2. 不设置密码则无访问限制
# 3. 设置密码后访问 Web 界面需要输入用户名和密码
#
# 更新测试(仅在开发环境需要):
# 1. 只支持公开仓库,不支持私有仓库
# 2. 如果不设置仓库配置,将使用默认的公开仓库 (linshenkx/prompt-optimizer)
# 3. 开发环境现在默认支持更新测试,无需额外配置文件
# 4. 更新日志将保存在用户数据目录的 logs/auto-updater.log 文件中