使用说明

项目简介

GenAIScript 是一个使用 JavaScript 构建和运行 LLM 脚本的框架。它旨在简化 Prompt 工程、LLM 流程编排、工具集成和数据处理。GenAIScript 支持模型上下文协议 (MCP) 工具，可以作为 LLM 应用的后端上下文服务。

主要功能点

程序化 Prompt 构建: 使用 JavaScript 代码灵活地构建和管理 Prompt。
LLM 流程编排: 在代码中协调和控制多个 LLM 的工作流程。
工具集成: 轻松注册和调用外部工具，扩展 LLM 的能力。
数据处理: 方便地处理和集成各种数据源到 Prompt 中。
内置 RAG: 集成检索增强生成 (RAG) 功能，提升 LLM 的知识获取能力。
支持多种模型: 兼容 GitHub Copilot、OpenAI、Azure OpenAI、Anthropic 等多种 LLM 模型，以及 Ollama 等本地模型。
数据模式定义: 支持定义和验证数据模式，确保数据质量。
文件摄取: 能够从 PDF、DOCX、CSV、XLSX 等多种文件格式中提取文本和数据。
文件生成与代码解释器: 支持生成文件和利用代码解释器执行代码。
系统 Prompt 与安全特性: 提供系统 Prompt 支持和内容安全验证机制。
自动化: 可通过命令行界面 (CLI) 和 API 进行自动化脚本执行。

安装步骤

请参考仓库 README 中的 Quickstart Guide，根据您的需求选择安装 Visual Studio Code 扩展或使用命令行工具。

服务器配置

MCP 客户端需要配置以下 JSON 信息以连接 GenAIScript 服务器：

{
  "serverName": "genaiscript",
  "command": "npx genaiscript run",
  "args": ["<your_script_file>.genai.js"]
  // serverName:  自定义 MCP 服务器实例的名称。
  // command:     启动 GenAIScript 服务器需要执行的命令。
  // args:        传递给命令的参数，用于指定要运行的 GenAIScript 文件。
  //            请将 "<your_script_file>.genai.js" 替换为您主要的 GenAIScript 文件的路径。
}

基本使用方法

编写 GenAIScript 脚本: 使用 JavaScript 编写 '.genai.js' 脚本文件，定义 Prompt、工具和数据处理逻辑。
定义上下文和 Prompt: 在脚本中使用
```
def()
```
函数定义上下文资源，使用
```
$
```
模板标签创建 Prompt。
注册工具: 使用
```
defTool()
```
函数注册外部工具，扩展 LLM 功能。
运行脚本: 通过 Visual Studio Code 扩展或命令行工具 ('npx genaiscript run <your_script_file>.genai.js') 运行脚本。
MCP 客户端连接: 配置 MCP 客户端，使用上述服务器配置信息连接到 GenAIScript 服务器，即可通过 MCP 协议进行通信。

关键词