项目简介

Archie AI Assistant项目旨在连接EPFL的企业架构(EA)存储库与Google Cloud及Google Gemini,利用大型语言模型(LLM)技术简化EA数据的访问、查询和维护工作。它充当用户的智能EA助手,帮助用户以自然语言交互,并自动化部分维护任务。

主要功能点

  • 支持使用自然语言查询企业架构存储库中的数据。
  • 提供助手功能,如智能查找和建议应用程序的编辑者(已实现)。
  • 未来计划扩展功能,包括协助填充应用程序详情、建议架构元素之间的关系、以及执行数据一致性检查。
  • 集成EPFL Google Workspace账户进行安全身份验证。
  • 后端核心功能部署为Google Cloud Functions。

安装步骤

  1. 克隆仓库: 使用 Git 命令克隆项目代码到本地。
  2. 配置Google Cloud环境: 确保您有权访问和配置必要的Google Cloud Platform资源(如Cloud Functions, Secret Manager等)。
  3. 配置Google Cloud IAM: 设置应用程序所需的身份和访问管理权限。
  4. 设置Python环境: 创建一个独立的 Python 虚拟环境,并使用 'pip' 安装项目所需的依赖库。
  5. 配置Secrets: 通过Google Cloud Secret Manager安全地存储和管理API密钥(主要用于访问Google Gemini API)。
  6. 部署与运行: 根据项目的具体文档(待完善的'CONTRIBUTING.md')将代码部署到Google Cloud Functions,并配置前端或其他客户端来调用它。

服务器配置 (供MCP客户端使用)

Archie AI Assistant的MCP服务器实现部署在Google Cloud Functions上,这是一种无服务器架构。与传统的在本地启动服务器进程不同,MCP客户端需要通过网络连接到部署在Google Cloud上的云函数入口点进行通信。

典型的MCP客户端需要一个JSON格式的配置对象来指定连接信息。该配置通常包含以下关键信息:

  • 'name': 用于标识此服务器连接的名称(字符串)。
  • 'type': 指示服务器实现的类型。对于云函数,可以是一个自定义值(例如,'cloud_function'),表明客户端应通过网络调用云函数而非启动本地进程。
  • 'endpoint': MCP客户端用于发送请求的云函数网络地址或URL(字符串)。这是云函数被触发的入口。
  • 'authentication': 如果云函数需要认证(通常需要,尤其是在企业环境中),此字段包含认证类型(如'oauth2'或其他)和必要的认证凭证或配置信息(JSON对象)。
  • 'params': 一个可选的JSON对象,用于传递调用云函数可能需要的额外参数,例如Google Cloud项目ID、特定的函数名称、地域信息等。

重要提示: 您需要从您的Google Cloud环境获取部署好的云函数的实际HTTP触发器URL以及任何所需的认证配置详细信息,才能正确配置MCP客户端。请参考您的Google Cloud Functions部署文档或联系系统管理员获取这些信息。

基本使用方法

项目的Web用户界面(前端部分)是与Archie AI Assistant交互的主要方式。通过您的EPFL Google Workspace账户登录Web界面后,您可以浏览企业架构数据,并利用界面上提供的功能(如针对特定应用程序点击"Find Editors"按钮)来触发AI助理的处理流程。AI助理将在后台的MCP服务器上执行数据查询、AI分析等任务,并将结果显示在用户界面上。

信息

分类

AI与计算