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
What is this?MetaGPT is a multi-agent framework that simulates a software company: you give it a one-line requirement and it coordinates roles like product manager, architect, project manager, and engineer to output user stories, designs, data structures, APIs, and code.
Is it a framework or a ready-made app?It is a Python framework/library with a CLI and a programmable SDK; you can call it as a library in your own code or run it from the command line.
How do I get it running?Create a conda environment with Python 3.9 (and under 3.12), install Node and pnpm, then install MetaGPT and initialize its config at ~/.metagpt/config2.yaml before running it via CLI or as a library.
What do I need before installing it?You need Python 3.9 to <3.12, plus Node and pnpm installed, and an LLM API key configured in the config file (OpenAI-compatible APIs are supported).
Any install pitfalls I should know about?The Python version window is strict (3.9 to just under 3.12), and you also need Node/pnpm set up separately before use, which is easy to miss if you only follow the Python install steps.
Does it run on Linux, macOS, and Windows?It is a Python package without OS restrictions in the README, so it works wherever a supported Python version, Node, and pnpm can be installed; a Docker image is also provided.
What is the core philosophy behind MetaGPT?MetaGPT's core idea is 'Code = SOP(Team)': it materializes standard operating procedures (SOPs) and applies them to teams composed of LLM agents.
What is Data Interpreter?Data Interpreter is a feature within MetaGPT that lets you have the agents write and execute code to solve data-related tasks, used alongside the standard company-role workflow.
What is MGX / mgx.dev?MGX (MetaGPT X) is a separate natural-language-programming product built by the MetaGPT team, described as the world's first AI agent development team, which has topped Product Hunt rankings.
What example use cases does it ship with?The repo documents use cases including Data Interpreter, Debate, Researcher, and a Receipt Assistant as demonstrations of what you can build with MetaGPT.
What are similar projects?ChatDev, bisheng, GVS5H, harmonist, devika, ruflo, dify, ClawWork
Which topics is it in?code-generation, gpt, large-language-models, orchestration, agentic-ai, multi-agent, framework, research, agent, automation, ai-agents, server
Creator
FoundationAgents
Size
179.7 MB
Stars
70.9K
Updated
CommitJan 21Releasev0.8.1Apr 22
Age
3y
Commits · 90 Days