VCP 旨在构建一个超越传统 AI 交互模式的中间层，它是一个高度兼容、通用、可扩展的工具箱，致力于赋能 AI 模型，使其能够与外部 API、服务和自定义逻辑进行无缝交互。我们的目标是创建一个适用于几乎所有 API 端口和客户端的强大 VCP (Variable & Command Protocol) 系统，极大地扩展 AI 的应用边界。

• 强大的插件化架构: 通过定义良好的插件清单 (plugin-manifest.json) 和核心插件管理器 (Plugin.js)，轻松集成和管理各种功能模块。
• VCP 协议: AI 通过在回复中嵌入特定格式的指令 (<<<[TOOL_REQUEST]>>> ... <<<[END_TOOL_REQUEST]>>>) 来调用插件，参数使用 key:「始」value「末」 格式，支持复杂数据类型和多行文本。
• 多种插件类型支持:
  • 静态插件 (static): 提供动态信息（如天气、自定义数据）以替换系统提示词中的占位符，支持定时刷新。
  • 消息预处理器插件 (messagePreprocessor): 在用户请求发送给 AI 模型前，对消息内容进行修改或增强（如图像识别与描述）。
  • 同步插件 (synchronous): AI 可以在对话中调用这些插件执行特定任务（如科学计算、图像生成、视频生成），服务器会等待插件执行完毕，并将结果反馈给 AI 进行后续处理。
  • 服务插件 (service): 允许插件向主应用注册独立的 HTTP 路由，提供额外的服务接口（如图床服务）。
• 灵活的配置管理: 支持全局配置文件 (config.env) 以及插件专属的 .env 文件，实现配置的层级化和隔离。
• 通用变量替换: 在与 AI 交互的各个阶段（系统提示词、用户消息）自动替换预定义的占位符变量。
• 内置实用功能:
  • 日记/记忆库系统: 自动提取和存储 AI 生成的结构化日记，并通过变量注入到提示词。
  • 动态表情包系统: 自动扫描和加载表情包，并通过变量和提示词模板供 AI 使用。
  • 提示词转换: 支持基于规则的系统提示词和全局上下文文本替换。
• 工具调用能力:
  • 非流式模式: 已实现对 AI 单次响应中包含的多个工具调用指令的循环处理和结果反馈。
  • 流式模式 (SSE): 当前主要支持 AI 单次响应中包含的单个工具调用指令的流式处理（即，AI首次响应流式输出，插件执行后，二次AI响应继续在原SSE流中输出）。
• 调试与日志: 提供调试模式和详细的日志记录，方便开发和问题排查。

1. 客户端请求: 客户端向 VCP 服务器的 /v1/chat/completions 端点发送请求。
2. server.js (核心服务器):
   • 接收请求，进行初步处理（如认证、变量替换）。
   • 调用 messagePreprocessor 插件（如 ImageProcessor）处理用户消息。
   • 将处理后的请求转发给后端 AI 模型。
3. AI 模型响应: AI 模型返回响应。
4. server.js 处理 AI 响应:
   • 检测 AI 响应中是否包含 VCP 工具调用指令 (<<<[TOOL_REQUEST]>>>)。
   • 如果包含工具调用：
     • 解析指令，提取工具名称和参数。
     • 调用 PluginManager 执行相应的 synchronous 插件。
5. Plugin.js (插件管理器):
   • 根据工具名称查找已加载的插件。
   • 为插件准备执行环境和配置。
   • 通过 stdio (或其他协议) 与插件脚本交互，发送输入并接收输出。
   • 将插件的执行结果（通常是 JSON）返回给 server.js。
6. server.js 二次 AI 调用:
   • 将插件的执行结果格式化后，作为新的用户消息添加到对话历史中。
   • 再次调用后端 AI 模型，将包含插件结果的完整对话历史发送过去。
   • 将 AI 的最终响应流式或非流式地返回给客户端。
7. 静态与服务插件:
   • static 插件（如 WeatherReporter）在服务器启动和定时任务中被 PluginManager 调用，其结果用于更新占位符变量。
   • service 插件（如 ImageServer）在服务器启动时由 PluginManager 初始化，向 Express 应用注册自己的路由。

• WeatherReporter (static): 获取并缓存天气信息，供 {{VCPWeatherInfo}} 变量使用。
• ImageProcessor (messagePreprocessor): 自动将用户消息中的 Base64 图片转译为文本描述，并进行缓存。
• SciCalculator (synchronous): 提供科学计算能力，支持数学函数、统计和微积分。
• ImageServer (service): 提供带密钥认证的静态图床服务。
• FluxGen (synchronous): 集成 SiliconFlow API 实现文生图功能，并将图片保存到本地服务器。
• Wan2.1VideoGen (synchronous): 集成 SiliconFlow Wan2.1 API 实现文生视频和图生视频功能。

1. 克隆项目:

   git clone <repository_url>
   cd <project_directory>

2. 安装主依赖 (Node.js):

   npm install

3. 安装 Python 插件依赖: 在项目根目录下运行以下命令，安装所有 Python 插件所需的依赖：

   pip install -r requirements.txt

   (注意: 各个 Node.js 插件的依赖已包含在主 package.json 中，或在其各自插件目录的 package.json 中通过 npm install 单独安装。)
4. 配置:
   • 复制 config.env.example (如果提供) 为 config.env，并根据说明填写所有必要的 API 密钥、URL、端口等信息。
   • 检查并配置各插件目录下的 .env 文件（如果存在）。
5. 启动服务器:

   node server.js

   服务器将监听在 config.env 中配置的端口。

1. 创建插件目录: 在 Plugin/ 目录下创建一个新的文件夹，例如 Plugin/MyNewPlugin/。
2. 编写插件清单 (plugin-manifest.json):
   • 在插件目录中创建 plugin-manifest.json。
   • 定义插件的 name, displayName, version, description, pluginType (static, messagePreprocessor, synchronous, service)。
   • 指定 entryPoint (例如，执行的脚本命令) 和 communication (如 protocol: "stdio").
   • 在 configSchema 中声明插件需要的配置项及其类型。
   • 在 capabilities 中详细描述插件功能：
     • 对于 static 插件，定义 systemPromptPlaceholders。
     • 对于 synchronous 插件，定义 invocationCommands，包括每个命令的 command 名称、详细的 description (包含参数说明、必需/可选、允许值、调用格式示例、成功/失败返回的JSON格式示例，以及与用户沟通的重要提示) 和 example (备用)。
3. 实现插件逻辑:
   • 根据 pluginType 和 entryPoint 实现插件的主逻辑脚本。
   • stdio 插件:
     • 从标准输入 (stdin) 读取数据 (对于 synchronous 插件，通常是 JSON 字符串形式的参数；对于 static 插件，可能无输入)。
     • 通过标准输出 (stdout) 返回结果 (通常是 JSON 字符串，包含 status: "success" 或 status: "error"，以及 result 或 error 字段；对于 static 插件，直接输出占位符的值)。
     • 可以通过标准错误 (stderr) 输出调试或错误信息。
     • 确保使用 UTF-8 编码进行 I/O。
   • messagePreprocessor 或 service 插件 (Node.js):
     • 导出一个符合 PluginManager 约定的模块 (例如，包含 initialize, processMessages, registerRoutes, shutdown 等方法)。
4. 配置与依赖:
   • 如果插件有独立的配置项，可以在插件目录下创建 .env 文件。
   • 如果插件有 Python 依赖，创建 requirements.txt；有 Node.js 依赖，创建 package.json。
5. 重启 VCP 服务器: PluginManager 会在启动时自动发现并加载新插件。
6. 更新系统提示词: 指导 AI 如何使用你的新插件，利用 {{VCPMyNewPlugin}} (由 PluginManager 根据 plugin-manifest.json 自动生成) 或直接在系统提示词中描述。

(此处可以列出 README.md 中已有的变量列表，确保与实际代码一致)

• {{Date}}: 当前日期 (格式: YYYY/M/D)。
• {{Time}}: 当前时间 (格式: H:MM:SS)。
• {{Today}}: 当天星期几 (中文)。
• {{Festival}}: 农历日期、生肖、节气。
• {{VCPWeatherInfo}}: 当前缓存的天气预报文本 (由 WeatherReporter 插件提供)。
• {{VCPPluginName}}: (例如 {{VCPWan2.1VideoGen}}) 由插件清单自动生成的、包含该插件所有命令描述和调用示例的文本块。
• ... (其他在旧 README 中定义的 Var*, Emoji*, Image_Key 等变量) ...
• {{ShowBase64}}: 当此占位符出现在用户消息或系统提示词中时，ImageProcessor 插件将被跳过。

• 完善异步插件的调用、状态跟踪和结果回调机制。
• 增强流式处理能力: 实现对 AI 单次响应中包含的多个工具调用指令的完整流式处理。
• 进一步增强插件间的通信与协作能力。
• 构建更丰富的插件生态。

本项目采用 Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International (CC BY-NC-SA 4.0) 许可证。

简单来说，这意味着您可以：

• 共享 — 在任何媒介以任何形式复制、发行本作品。
• 演绎 — 修改、转换或以本作品为基础进行创作。 只要你遵守许可协议条款，许可人就无法收回你的这些权利。

惟须遵守下列条件：

• 署名 (BY) — 您必须给出适当的署名，提供指向本许可的链接，同时标明是否（对原始作品）作了修改。您可以用任何合理的方式来署名，但是不得以任何方式暗示许可人为您或您的使用背书。
• 非商业性使用 (NC) — 您不得将本作品用于商业目的。
• 相同方式共享 (SA) — 如果您再混合、转换或者基于本作品进行创作，您必须基于与原先许可协议相同的许可协议分发您贡献的作品。

详情请参阅 LICENSE 文件。

• 开发阶段: 本 VCP 工具箱项目目前仍处于积极开发阶段。虽然我们努力确保其功能的稳定性和可靠性，但仍可能存在未知的错误、缺陷或不完整的功能。
• 按原样提供: 本项目按“原样”和“可用”状态提供，不附带任何形式的明示或暗示的保证，包括但不限于对适销性、特定用途适用性和非侵权性的保证。
• 风险自负: 您理解并同意，使用本项目的风险完全由您自行承担。对于因使用或无法使用本项目（包括其插件和依赖的外部API）而导致的任何直接、间接、偶然、特殊、后果性或惩罚性损害（包括但不限于利润损失、数据丢失或业务中断），开发者不承担任何责任，即使已被告知此类损害的可能性。
• 无商业化授权: 鉴于项目当前状态和所采用的 CC BY-NC-SA 4.0 许可证，明确禁止将本项目及其衍生作品用于任何主要的商业目的或获取金钱报酬的活动。本项目主要用于学习、研究和非商业性实验。
• API 使用成本: 请注意，本项目集成的部分插件（如 FluxGen, Wan2.1VideoGen）依赖于第三方 API 服务，这些服务可能会产生费用。您有责任了解并承担使用这些 API 所产生的任何成本。强烈建议在使用前仔细阅读相关 API 提供商的定价策略和使用条款。
• 安全责任: 请勿在配置文件 (config.env 或插件的 .env 文件) 中硬编码或提交真实的、敏感的 API 密钥到公共代码库。请妥善保管您的密钥。

我们相信，VCP 将为 AI 应用的开发带来前所未有的灵活性和可能性。欢迎贡献和反馈！