README.md

metadata

title: Code2MCP-FoamAgent
emoji: 🧪
colorFrom: blue
colorTo: green
sdk: docker
sdk_version: 4.26.0
app_file: app.py
pinned: false

Code2MCP-FoamAgent

Foam-Agent 的 MCP (Model Context Protocol) 服务包装器，提供基于自然语言的 OpenFOAM CFD 仿真工作流。

功能特性

• 🧪 基于自然语言的 CFD 仿真需求
• 🤖 多智能体工作流自动化
• 📊 自动错误检测和修正
• 🔧 自定义网格支持 (GMSH .msh 文件)
• 🌐 多种 LLM 提供商支持

快速开始

1. 环境配置

复制环境变量模板并配置：

cp env.example .env

编辑 .env 文件，设置您的 API 密钥：

# OpenAI API Configuration
OPENAI_API_KEY=your_openai_api_key_here
OPENAI_BASE_URL=https://api.openai.com/v1

# 或者使用自定义 API 端点
# OPENAI_BASE_URL=https://api.gptsapi.net/v1

2. 安装依赖

使用 conda（推荐）

# 创建 conda 环境
conda env create -f environment.yml

# 激活环境
conda activate openfoamAgent

# 安装额外的 MCP 依赖
pip install fastapi uvicorn[standard] fastmcp

3. 运行 MCP 服务

python Foam-Agent/mcp_output/start_mcp.py

4. Docker 部署

方法一：使用 .env 文件（推荐）

# 1. 创建 .env 文件
cp env.example .env
# 编辑 .env 文件，填入您的 API 密钥

# 2. 使用 docker-compose（推荐）
docker-compose up -d

# 3. 或者使用 docker run
docker run -p 7860:7860 --env-file .env code2mcp-foamagent

方法二：直接设置环境变量

# 构建镜像
docker build -t code2mcp-foamagent .

# 运行容器（设置环境变量）
docker run -p 7860:7860 \
  -e OPENAI_API_KEY=your_api_key_here \
  -e OPENAI_BASE_URL=https://api.openai.com/v1 \
  code2mcp-foamagent

使用方法

基本 CFD 仿真

# 运行简单的 CFD 仿真
result = run_foam_agent(
    requirements="Do an incompressible lid driven cavity flow...",
    output_dir="./output"
)

使用自定义网格

# 使用自定义 GMSH 网格文件
result = run_foam_agent(
    requirements="Simulate flow over a tandem wing...",
    output_dir="./output",
    custom_mesh="./tandem_wing.msh"
)

完整基准测试

# 运行完整的 Foam-Agent 基准测试
result = run_foam_benchmark(
    openfoam_path="/opt/openfoam10",
    requirements="Your CFD requirements...",
    output_dir="./output"
)

环境变量

变量名	描述	默认值
OPENAI_API_KEY	OpenAI API 密钥	必需
OPENAI_BASE_URL	OpenAI API 基础 URL	https://api.openai.com/v1
WM_PROJECT_DIR	OpenFOAM 安装路径	/opt/openfoam10
MODEL_PROVIDER	LLM 提供商	openai
MODEL_VERSION	模型版本	gpt-4o
MCP_TRANSPORT	MCP 传输模式	http
MCP_PORT	MCP 服务端口	7860

系统要求

• Python 3.11+
• OpenFOAM v10
• OpenAI API 密钥或其他 LLM 提供商
• 预处理的 OpenFOAM 数据库

故障排除

1. 检查系统状态：使用 check_foam_agent_status 工具
2. 验证 API 配置：确保 API 密钥和 URL 正确设置
3. 检查依赖：确保所有 Python 包已正确安装
4. OpenFOAM 环境：确保 OpenFOAM 已正确安装并配置

许可证

MIT License