【AI Agent系列】【MetaGPT多智能体学习】3. 开发一个简单的多智能体系统，兼看MetaGPT多智能体运行机制

本系列文章跟随《MetaGPT多智能体课程》（https://github.com/datawhalechina/hugging-multi-agent），深入理解并实践多智能体系统的开发。

本文为该课程的第四章（多智能体开发）的第一篇笔记。主要记录下多智能体的运行机制及跟着教程，实现一个简单的多智能体系统。

系列笔记

• 【AI Agent系列】【MetaGPT多智能体学习】0. 环境准备 - 升级MetaGPT 0.7.2版本及遇到的坑
• 【AI Agent系列】【MetaGPT多智能体学习】1. 再理解 AI Agent - 经典案例和热门框架综述
• 【AI Agent系列】【MetaGPT多智能体学习】2. 重温单智能体开发 - 深入源码，理解单智能体运行框架

0. 多智能体间互通的方式 - Enviroment组件

0.1 多智能体间协作方式简介

在上次课中，我也曾写过 多智能体运行机制 的笔记（这篇文章：【AI Agent系列】【MetaGPT】【深入源码】智能体的运行周期以及多智能体间如何协作）。其中我自己通过看源码，总结出了MetaGPT多智能体间协作的方式：

（1）每一个Role都在不断观察环境中的信息（_observe函数）
（2）当观察到自己想要的信息后，就会触发后续相应的动作
（3）如果没有观察到想要的信息，则会一直循环观察
（4）执行完动作后，会将产生的msg放到环境中（publish_message），供其它Role智能体来使用。

现在再结合《MetaGPT多智能体》课程的教案，发现还是理解地有些浅了，我只关注了智能体在关注自己想要的信息，观察到了之后就开始行动，而忽略了其背后的基础组件 - Enviroment。

0.2 Environment组件 - 深入源码

MetaGPT中对Environment的定义：环境，承载一批角色，角色可以向环境发布消息，可以被其他角色观察到。短短一句话，总结三个功能：

• 承载角色
• 接收角色发布的消息
• 环境中的消息被角色得到

下面我们分开来细说。

0.2.1 参数介绍

首先来看下 Environment 的参数：

class Environment(ExtEnv):
    """环境，承载一批角色，角色可以向环境发布消息，可以被其他角色观察到
    Environment, hosting a batch of roles, roles can publish messages to the environment, and can be observed by other roles
    """

    model_config = ConfigDict(arbitrary_types_allowed=True)

    desc: str = Field(default="")  # 环境描述
    roles: dict[str, SerializeAsAny["Role"]] = Field(default_factory=dict, validate_default=True)
    member_addrs: Dict["Role", Set] = Field(default_factory=dict, exclude=True)
    history: str = ""  # For debug
    context: Context = Field(default_factory=Context, exclude=True)
1
2
3
4
5
6
7
8
9
10
11
12

• desc：环境的描述
• roles：字典类型，指定当前环境中的角色
• member_addrs：字典类型，表示当前环境中的角色以及他们对应的状态
• history：记录环境中发生的消息记录
• context：当前环境的一些上下文信息

0.2.2 add_roles函数 - 承载角色

def add_roles(self, roles: Iterable["Role"]):
    """增加一批在当前环境的角色
    Add a batch of characters in the current environment
    """
    for role in roles:
        self.roles[role.profile] = role

    for role in roles:  # setup system message with roles
        role.set_env(self)
        role.context = self.context
1
2
3
4
5
6
7
8
9
10

从源码中看，这个函数的功能有两个：

（1）给 Environment 的 self.roles 参数赋值，上面我们已经知道它是一个字典类型，现在看来，它的 key 为 role 的 profile，值为 role 本身。

疑问： role 的 profile 默认是空（profile: str = ""），可以没有值，那如果使用者懒得写profile，这里会不会最终只有一个 Role，导致无法实现多智能体？欢迎讨论交流。

（2）给添加进来的 role 设置环境信息

Role的 set_env 函数源码如下，它又给env设置了member_addrs。有点绕？

def set_env(self, env: "Environment"):
    """Set the environment in which the role works. The role can talk to the environment and can also receive
    messages by observing."""
    self.rc.env = env
    if env:
        env.set_addresses(self, self.addresses)
        self.llm.system_prompt = self._get_prefix()
        self.set_actions(self.actions)  # reset actions to update llm and prefix
1
2
3
4
5
6
7
8

通过 add_roles 函数，将 role 和 Environment 关联起来。

0.2.3 publish_message函数 - 接收角色发布的消息 / 环境中的消息被角色得到

Environment 中的 publish_message 函数是 Role 在执行完动作之后，将自身产生的消息发布到环境中调用的接口。Role的调用方式如下：

def publish_message(self, msg):
    """If the role belongs to env, then the role's messages will be broadcast to env"""
    if not msg:
        return
    if not self.rc.env:
        # If env does not exist, do not publish the message
        return
    self.rc.env.publish_message(msg)
1
2
3
4
5
6
7
8

通过上面的代码来看，一个Role只能存在于一个环境中？

然后看下 Environment 中源码：

def publish_message(self, message: Message, peekable: bool = True) -> bool:
    """
    Distribute the message to the recipients.
    In accordance with the Message routing structure design in Chapter 2.2.1 of RFC 116, as already planned
    in RFC 113 for the entire system, the routing information in the Message is only responsible for
    specifying the message recipient, without concern for where the message recipient is located. How to
    route the message to the message recipient is a problem addressed by the transport framework designed
    in RFC 113.
    """
    logger.debug(f"publish_message: {message.dump()}")
    found = False
    # According to the routing feature plan in Chapter 2.2.3.2 of RFC 113
    for role, addrs in self.member_addrs.items():
        if is_send_to(message, addrs):
            role.put_message(message)
            found = True
    if not found:
        logger.warning(f"Message no recipients: {message.dump()}")
    self.history += f"\n{message}"  # For debug

    return True
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

其中重点是这三行代码，检查环境中的所有Role是否订阅了该消息（或该消息是否应该发送给环境中的某个Role），如果订阅了，则调用Role的put_message函数，Role的 put_message函数的作用是将message放到本身的msg_buffer中：

for role, addrs in self.member_addrs.items():
    if is_send_to(message, addrs):
        role.put_message(message)
1
2
3

这样就实现了将环境中的某个Role的Message放到环境中，并通知给环境中其它的Role的机制。

0.2.4 run函数 - 运行入口

run函数的源码如下：

async def run(self, k=1):
    """处理一次所有信息的运行
    Process all Role runs at once
    """
    for _ in range(k):
        futures = []
        for role in self.roles.values():
            future = role.run()
            futures.append(future)

        await asyncio.gather(*futures)
        logger.debug(f"is idle: {self.is_idle}")
1
2
3
4
5
6
7
8
9
10
11
12

k = 1, 表示处理一次消息？为什么要有这个值，难道还能处理多次？意义是什么？

该函数其实就是遍历一遍当前环境中的所有Role，然后运行Role的run函数（运行单智能体）。

Role的run里面，就是用该环境观察信息，行动，发布信息到环境。这样多个Role的运行就通过 Environment 串起来了，这些之前已经写过了，不再赘述，见：【AI Agent系列】【MetaGPT】【深入源码】智能体的运行周期以及多智能体间如何协作。

1. 开发一个简单的多智能体系统

复现教程中的demo。

1.1 多智能体需求描述

• 两个智能体：学生 和 老师
• 任务及预期流程：学生写诗 —> 老师给改进意见 —> 学生根据意见改进 —> 老师给改进意见 —> … n轮 … —> 结束

1.2 代码实现

1.2.1 学生智能体

学生智能体的主要内容就是根据指定的内容写诗。

因此，首先定义一个写诗的Action：WritePoem。

然后，定义学生智能体，指定它的动作就是写诗（self.set_actions([WritePoem])）

那么它什么时候开始动作呢？通过 self._watch([UserRequirement, ReviewPoem]) 设置其观察的信息。当它观察到环境中有了 UserRequirement 或者 ReviewPoem 产生的信息之后，开始动作。UserRequirement为用户的输入信息类型。

class WritePoem(Action):

    name: str = "WritePoem"

    PROMPT_TEMPLATE: str = """
    Here is the historical conversation record : {msg} .
    Write a poem about the subject provided by human, Return only the content of the generated poem with NO other texts.
    If the teacher provides suggestions about the poem, revise the student's poem based on the suggestions and return.
    your poem:
    """

    async def run(self, msg: str):
        prompt = self.PROMPT_TEMPLATE.format(msg = msg)
        rsp = await self._aask(prompt)
        return rsp

class Student(Role):

    name: str = "xiaoming"
    profile: str = "Student"

    def __init__(self, **kwargs):
        super().__init__(**kwargs)
        self.set_actions([WritePoem])
        self._watch([UserRequirement, ReviewPoem])

    async def _act(self) -> Message:
        logger.info(f"{self._setting}: ready to {self.rc.todo}")
        todo = self.rc.todo

        msg = self.get_memories()  # 获取所有记忆
        # logger.info(msg)
        poem_text = await WritePoem().run(msg)
        logger.info(f'student : {poem_text}')
        msg = Message(content=poem_text, role=self.profile,
                      cause_by=type(todo))

        return msg
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38

1.2.2 老师智能体

老师的智能体的任务是根据学生写的诗，给出修改意见。

因此创建一个Action为ReviewPoem。

然后，创建老师的智能体，指定它的动作为Review（self.set_actions([ReviewPoem])）

它的触发实际应该是学生写完诗以后，因此，加入self._watch([WritePoem])

class ReviewPoem(Action):

    name: str = "ReviewPoem"

    PROMPT_TEMPLATE: str = """

    Here is the historical conversation record : {msg} .
    Check student-created poems about the subject provided by human and give your suggestions for revisions. You prefer poems with elegant sentences and retro style.
    Return only your comments with NO other texts.
    your comments:
    """

    async def run(self, msg: str):
        prompt = self.PROMPT_TEMPLATE.format(msg = msg)
        rsp = await self._aask(prompt)
        return rsp

class Teacher(Role):

    name: str = "laowang"
    profile: str = "Teacher"

    def __init__(self, **kwargs):
        super().__init__(**kwargs)
        self.set_actions([ReviewPoem])
        self._watch([WritePoem])

    async def _act(self) -> Message:
        logger.info(f"{self._setting}: ready to {self.rc.todo}")
        todo = self.rc.todo

        msg = self.get_memories()  # 获取所有记忆
        poem_text = await ReviewPoem().run(msg)
        logger.info(f'teacher : {poem_text}')
        msg = Message(content=poem_text, role=self.profile,
                      cause_by=type(todo))

        return msg
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38

1.2.3 创建多智能体交流的环境

前面我们已经知道了多智能体之间的交互需要一个非常重要的组件 - Environment。

因此，创建一个供多智能体交流的环境，通过 add_roles 加入智能体。

然后，当用户输入内容时，将该内容添加到环境中publish_message，从而触发相应智能体开始运行。这里cause_by=UserRequirement代表消息是由用户产生的，学生智能体关心这类消息，观察到之后就开始行动了。

classroom = Environment()

classroom.add_roles([Student(), Teacher()])

classroom.publish_message(
    Message(role="Human", content=topic, cause_by=UserRequirement,
            send_to='' or MESSAGE_ROUTE_TO_ALL),
    peekable=False,
)

1
2
3
4
5
6
7
8
9
10

1.2.4 运行

加入相应头文件，指定交互次数，就可以开始跑了。注意交互次数，直接决定了你的程序的效果和你的钱包！

import asyncio

from metagpt.actions import Action, UserRequirement
from metagpt.logs import logger
from metagpt.roles import Role
from metagpt.schema import Message
from metagpt.environment import Environment

from metagpt.const import MESSAGE_ROUTE_TO_ALL

async def main(topic: str, n_round=3):
    while n_round > 0:
        # self._save()
        n_round -= 1
        logger.debug(f"max {n_round=} left.")

        await classroom.run()
    return classroom.history

asyncio.run(main(topic='wirte a poem about moon'))
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

1.2.5 完整代码

import asyncio

from metagpt.actions import Action, UserRequirement
from metagpt.logs import logger
from metagpt.roles import Role
from metagpt.schema import Message
from metagpt.environment import Environment

from metagpt.const import MESSAGE_ROUTE_TO_ALL

classroom = Environment()

class WritePoem(Action):

    name: str = "WritePoem"

    PROMPT_TEMPLATE: str = """
    Here is the historical conversation record : {msg} .
    Write a poem about the subject provided by human, Return only the content of the generated poem with NO other texts.
    If the teacher provides suggestions about the poem, revise the student's poem based on the suggestions and return.
    your poem:
    """

    async def run(self, msg: str):

        prompt = self.PROMPT_TEMPLATE.format(msg = msg)

        rsp = await self._aask(prompt)

        return rsp

class ReviewPoem(Action):

    name: str = "ReviewPoem"

    PROMPT_TEMPLATE: str = """

    Here is the historical conversation record : {msg} .
    Check student-created poems about the subject provided by human and give your suggestions for revisions. You prefer poems with elegant sentences and retro style.
    Return only your comments with NO other texts.
    your comments:
    """

    async def run(self, msg: str):

        prompt = self.PROMPT_TEMPLATE.format(msg = msg)

        rsp = await self._aask(prompt)

        return rsp
    
class Student(Role):

    name: str = "xiaoming"
    profile: str = "Student"

    def __init__(self, **kwargs):
        super().__init__(**kwargs)
        self.set_actions([WritePoem])
        self._watch([UserRequirement, ReviewPoem])

    async def _act(self) -> Message:
        logger.info(f"{self._setting}: ready to {self.rc.todo}")
        todo = self.rc.todo

        msg = self.get_memories()  # 获取所有记忆
        # logger.info(msg)
        poem_text = await WritePoem().run(msg)
        logger.info(f'student : {poem_text}')
        msg = Message(content=poem_text, role=self.profile,
                      cause_by=type(todo))

        return msg

class Teacher(Role):

    name: str = "laowang"
    profile: str = "Teacher"

    def __init__(self, **kwargs):
        super().__init__(**kwargs)
        self.set_actions([ReviewPoem])
        self._watch([WritePoem])

    async def _act(self) -> Message:
        logger.info(f"{self._setting}: ready to {self.rc.todo}")
        todo = self.rc.todo

        msg = self.get_memories()  # 获取所有记忆
        poem_text = await ReviewPoem().run(msg)
        logger.info(f'teacher : {poem_text}')
        msg = Message(content=poem_text, role=self.profile,
                      cause_by=type(todo))

        return msg

async def main(topic: str, n_round=3):

    classroom.add_roles([Student(), Teacher()])

    classroom.publish_message(
        Message(role="Human", content=topic, cause_by=UserRequirement,
                send_to='' or MESSAGE_ROUTE_TO_ALL),
        peekable=False,
    )

    while n_round > 0:
        # self._save()
        n_round -= 1
        logger.debug(f"max {n_round=} left.")

        await classroom.run()
    return classroom.history

asyncio.run(main(topic='wirte a poem about moon'))
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115

• 运行结果

2. 总结

总结一下整个流程吧，画了个图。

从最外围环境 classroom开始，用户输入的信息通过 publish_message 发送到所有Role中，通过Role的 put_message 放到自身的 msg_buffer中。

当Role运行run时，_observe从msg_buffer中提取信息，然后只过滤自己关心的消息，例如Teacher只过滤出来自WritePoem的，其它消息虽然在msg_buffer中，但不处理。同时，msg_buffer中的消息会存入memory中。

run完即执行完相应动作后，通过publish_message将结果消息发布到环境中，环境的publish_message又将这个消息发送个全部的Role，这时候所有的Role的msg_buffer中都有了这个消息。完成了智能体间信息的一个交互闭环。

---

站内文章一览