MetaGPT README

The project's README from github.com/FoundationAgents/MetaGPT. As one markdown file: README.md.

MetaGPT: The Multi-Agent Framework

MetaGPT logo: Enable GPT to work in a software company, collaborating to tackle more complex tasks.

[ En | 中 | Fr | 日 ] Assign different roles to GPTs to form a collaborative entity for complex tasks.

License: MIT Discord Follow Twitter Follow

News

🚀 Mar. 10, 2025: 🎉 mgx.dev is the #1 Product of the Week on @ProductHunt! 🏆

🚀 Mar.   4, 2025: 🎉 mgx.dev is the #1 Product of the Day on @ProductHunt! 🏆

🚀 Feb. 19, 2025: Today we are officially launching our natural language programming product: MGX (MetaGPT X) - the world's first AI agent development team. More details on Twitter.

🚀 Feb. 17, 2025: We introduced two papers: SPO and AOT, check the code!

🚀 Jan. 22, 2025: Our paper AFlow: Automating Agentic Workflow Generation accepted for oral presentation (top 1.8%) at ICLR 2025, ranking #2 in the LLM-based Agent category.

👉👉 Earlier news

Software Company as Multi-Agent System

  1. MetaGPT takes a one line requirement as input and outputs user stories / competitive analysis / requirements / data structures / APIs / documents, etc.
  2. Internally, MetaGPT includes product managers / architects / project managers / engineers. It provides the entire process of a software company along with carefully orchestrated SOPs.
    1. Code = SOP(Team) is the core philosophy. We materialize SOP and apply it to teams composed of LLMs.

A software company consists of LLM-based roles

Software Company Multi-Agent Schematic (Gradually Implementing)

Get Started

Installation

Ensure that Python 3.9 or later, but less than 3.12, is installed on your system. You can check this by using: python --version.
You can use conda like this: conda create -n metagpt python=3.9 && conda activate metagpt

pip install --upgrade metagpt
# or `pip install --upgrade git+https://github.com/geekan/MetaGPT.git`
# or `git clone https://github.com/geekan/MetaGPT && cd MetaGPT && pip install --upgrade -e .`

Install node and pnpm before actual use.

For detailed installation guidance, please refer to cli_install or docker_install

Configuration

You can init the config of MetaGPT by running the following command, or manually create ~/.metagpt/config2.yaml file:

# Check https://docs.deepwisdom.ai/main/en/guide/get_started/configuration.html for more details
metagpt --init-config  # it will create ~/.metagpt/config2.yaml, just modify it to your needs

You can configure ~/.metagpt/config2.yaml according to the example and doc:

llm:
  api_type: "openai"  # or azure / ollama / groq etc. Check LLMType for more options
  model: "gpt-4-turbo"  # or gpt-3.5-turbo
  base_url: "https://api.openai.com/v1"  # or forward url / other llm url
  api_key: "YOUR_API_KEY"

Usage

After installation, you can use MetaGPT at CLI

metagpt "Create a 2048 game"  # this will create a repo in ./workspace

or use it as library

from metagpt.software_company import generate_repo
from metagpt.utils.project_repo import ProjectRepo

repo: ProjectRepo = generate_repo("Create a 2048 game")  # or ProjectRepo("<path>")
print(repo)  # it will print the repo structure with files

You can also use Data Interpreter to write code:

import asyncio
from metagpt.roles.di.data_interpreter import DataInterpreter

async def main():
    di = DataInterpreter()
    await di.run("Run data analysis on sklearn Iris dataset, include a plot")

asyncio.run(main())  # or await main() in a jupyter notebook setting

QuickStart & Demo Video

https://github.com/user-attachments/assets/888cb169-78c3-4a42-9d62-9d90ed3928c9

Tutorial

Support

Discord Join US

📢 Join Our Discord Channel! Looking forward to seeing you there! 🎉

Contributor form

📝 Fill out the form to become a contributor. We are looking forward to your participation!

Contact Information

If you have any questions or feedback about this project, please feel free to contact us. We highly appreciate your suggestions!

We will respond to all questions within 2-3 business days.

Citation

To stay updated with the latest research and development, follow @MetaGPT_ on Twitter.

To cite MetaGPT in publications, please use the following BibTeX entries.

@inproceedings{hong2024metagpt,
      title={Meta{GPT}: Meta Programming for A Multi-Agent Collaborative Framework},
      author={Sirui Hong and Mingchen Zhuge and Jonathan Chen and Xiawu Zheng and Yuheng Cheng and Jinlin Wang and Ceyao Zhang and Zili Wang and Steven Ka Shing Yau and Zijuan Lin and Liyang Zhou and Chenyu Ran and Lingfeng Xiao and Chenglin Wu and J{\"u}rgen Schmidhuber},
      booktitle={The Twelfth International Conference on Learning Representations},
      year={2024},
      url={https://openreview.net/forum?id=VtmBAGCN7o}
}

For more work, please refer to Academic Work.

MetaGPT (FoundationAgents/MetaGPT)

Searching Database…

70.9K ·GitHub
这是什么?MetaGPT 是一个模拟软件公司的多智能体框架:你给它一行需求,它就会协调产品经理、架构师、项目经理、工程师等角色,输出用户故事、设计、数据结构、API 和代码。
它是框架还是现成的应用?它是一个带命令行界面(CLI)和可编程 SDK 的 Python 框架/库:你既可以在自己的代码中把它当库调用,也可以从命令行运行。
怎么把它跑起来?创建一个 Python 3.9(且低于 3.12)的 conda 环境,安装 Node 和 pnpm,然后安装 MetaGPT,并在 ~/.metagpt/config2.yaml 初始化配置,之后即可通过 CLI 或作为库来运行。
安装之前需要准备什么?需要 Python 3.9 到 3.12 以下的版本,还要装好 Node 和 pnpm,并在配置文件中配置 LLM API 密钥(支持兼容 OpenAI 的 API)。
安装有什么坑需要注意吗?Python 版本区间要求很严(3.9 到 3.12 以下),而且使用前还要单独装好 Node/pnpm——如果只照着 Python 的安装步骤走,很容易漏掉这一点。
它在 Linux、macOS 和 Windows 上都能运行吗?它是一个 Python 包,README 里没有操作系统限制,所以只要能装上受支持的 Python 版本、Node 和 pnpm 就能运行;另外还提供 Docker 镜像。
MetaGPT 的核心理念是什么?MetaGPT 的核心思想是“Code = SOP(Team)”:它把标准操作流程(SOP)具象化,并应用到由 LLM 智能体组成的团队上。
Data Interpreter 是什么?Data Interpreter 是 MetaGPT 内置的一项功能,可以让智能体编写并执行代码来解决数据相关的任务,通常与标准的公司角色工作流配合使用。
MGX / mgx.dev 是什么?MGX(MetaGPT X)是 MetaGPT 团队推出的另一款自然语言编程产品,被称为全球首个 AI 智能体开发团队,曾登顶 Product Hunt 榜单。
它自带哪些示例用例?仓库中记录了 Data Interpreter、Debate(辩论)、Researcher(研究员)和票据助手(Receipt Assistant)等用例,展示用 MetaGPT 能构建什么。
What are similar projects?ChatDev, GVS5H, bisheng, harmonist, devika, ruflo, ClawWork, dify
Size
179.7 MB
Stars
70.9K
Age
3y
Commits · 90 Days