feat: software action + api interface

metagpt/actions/design_api.py

@@ -8,6 +8,7 @@
             1. According to Section 2.2.3.1 of RFC 135, replace file data in the message with the file name.
             2. According to the design in Section 2.2.3.5.3 of RFC 135, add incremental iteration functionality.
 @Modified By: mashenquan, 2023/12/5. Move the generation logic of the project name to WritePRD.
+@Modified By: mashenquan, 2024/5/31. Implement Chapter 3 of RFC 236.
 """
 import json
 import uuid
@@ -28,6 +29,7 @@ from metagpt.actions.design_api_an import (
 from metagpt.const import DATA_API_DESIGN_FILE_REPO, SEQ_FLOW_FILE_REPO
 from metagpt.logs import logger
 from metagpt.schema import AIMessage, Document, Documents, Message
+from metagpt.tools.tool_registry import register_tool
 from metagpt.utils.common import aread, awrite, to_markdown_code_block
 from metagpt.utils.mermaid import mermaid_to_file
 from metagpt.utils.project_repo import ProjectRepo
@@ -42,6 +44,7 @@ NEW_REQ_TEMPLATE = """
 """
 
 
+@register_tool(tags=["software development", "write system design"])
 class WriteDesign(Action):
     name: str = ""
     i_context: Optional[str] = None
@@ -163,7 +166,7 @@ class WriteDesign(Action):
                 output_path=output_path,
             )
 
-        self.input_args = with_messages[0].instruct_content
+        self.input_args = with_messages[-1].instruct_content
         self.repo = ProjectRepo(self.input_args.project_path)
         changed_prds = self.input_args.changed_prd_filenames
         changed_system_designs = [
@@ -283,7 +286,12 @@ class WriteDesign(Action):
             )
 
         if not output_path:
-            return AIMessage(content=design.instruct_content.model_dump_json())
+            return AIMessage(content=design.content)
         output_filename = Path(output_path) / f"{uuid.uuid4().hex}.json"
         await awrite(filename=output_filename, data=design.content)
-        return AIMessage(content=f'System Design filename: "{str(output_filename)}"')
+        kvs = {"changed_system_design_filenames": [output_filename]}
+
+        return AIMessage(
+            content=f'System Design filename: "{str(output_filename)}"',
+            instruct_content=AIMessage.create_instruct_value(kvs=kvs),
+        )

metagpt/actions/prepare_documents.py

@@ -46,8 +46,8 @@ class PrepareDocuments(Action):
             path = Path(self.config.project_path)
         if path.exists() and not self.config.inc:
             shutil.rmtree(path)
-        self.config.project_path = path
-        self.context.set_repo_dir(path)
+        self.context.kwargs.project_path = path
+        self.context.kwargs.inc = self.config.inc
         return ProjectRepo(path)
 
     async def run(self, with_messages, **kwargs):

metagpt/actions/project_management.py

@@ -8,6 +8,7 @@
         1. Divide the context into three components: legacy code, unit test code, and console log.
         2. Move the document storage operations related to WritePRD from the save operation of WriteDesign.
         3. According to the design in Section 2.2.3.5.4 of RFC 135, add incremental iteration functionality.
+@Modified By: mashenquan, 2024/5/31. Implement Chapter 3 of RFC 236.
 """
 
 import json
@@ -21,6 +22,7 @@ from metagpt.actions.project_management_an import PM_NODE, REFINED_PM_NODE
 from metagpt.const import PACKAGE_REQUIREMENTS_FILENAME
 from metagpt.logs import logger
 from metagpt.schema import AIMessage, Document, Documents, Message
+from metagpt.tools.tool_registry import register_tool
 from metagpt.utils.common import aread, to_markdown_code_block
 from metagpt.utils.project_repo import ProjectRepo
 from metagpt.utils.report import DocsReporter
@@ -34,6 +36,7 @@ NEW_REQ_TEMPLATE = """
 """
 
 
+@register_tool(tags=["software development", "write a project schedule given a project system design file"])
 class WriteTasks(Action):
     name: str = "CreateTasks"
     i_context: Optional[str] = None
@@ -73,7 +76,7 @@ class WriteTasks(Action):
         if not with_messages:
             return await self._execute_api(user_requirement=user_requirement, design_filename=design_filename)
 
-        self.input_args = with_messages[0].instruct_content
+        self.input_args = with_messages[-1].instruct_content
         self.repo = ProjectRepo(self.input_args.project_path)
         changed_system_designs = self.input_args.changed_system_design_filenames
         changed_tasks = [str(self.repo.docs.task.workdir / i) for i in list(self.repo.docs.task.changed_files.keys())]
@@ -82,7 +85,7 @@ class WriteTasks(Action):
         # `docs/system_designs/`.
         for filename in changed_system_designs:
             task_doc = await self._update_tasks(filename=filename)
-            change_files.docs[filename] = task_doc
+            change_files.docs[str(self.repo.docs.task.workdir / task_doc.filename)] = task_doc
 
         # Rewrite the task files that have undergone changes based on the git head diff under `docs/tasks/`.
         for filename in changed_tasks:

metagpt/actions/write_prd.py

@@ -9,6 +9,7 @@
             2. According to the design in Section 2.2.3.5.2 of RFC 135, add incremental iteration functionality.
             3. Move the document storage operations related to WritePRD from the save operation of WriteDesign.
 @Modified By: mashenquan, 2023/12/5. Move the generation logic of the project name to WritePRD.
+@Modified By: mashenquan, 2024/5/31. Implement Chapter 3 of RFC 236.
 """
 
 from __future__ import annotations
@@ -38,6 +39,7 @@ from metagpt.const import (
 )
 from metagpt.logs import logger
 from metagpt.schema import AIMessage, Document, Documents, Message
+from metagpt.tools.tool_registry import register_tool
 from metagpt.utils.common import CodeParser, aread, awrite, to_markdown_code_block
 from metagpt.utils.file_repository import FileRepository
 from metagpt.utils.mermaid import mermaid_to_file
@@ -64,6 +66,7 @@ NEW_REQ_TEMPLATE = """
 """
 
 
+@register_tool(tags=["software development", "write product requirement documents"])
 class WritePRD(Action):
     """WritePRD deal with the following situations:
     1. Bugfix: If the requirement is a bugfix, the bugfix document will be generated.
@@ -145,11 +148,11 @@ class WritePRD(Action):
 
         self.input_args = with_messages[-1].instruct_content
         if not self.input_args:
-            self.repo = ProjectRepo(self.config.project_path)
+            self.repo = ProjectRepo(self.context.kwargs.project_path)
             await self.repo.docs.save(filename=REQUIREMENT_FILENAME, content=with_messages[-1].content)
             self.input_args = AIMessage.create_instruct_value(
                 kvs={
-                    "project_path": self.config.project_path,
+                    "project_path": self.context.kwargs.project_path,
                     "requirements_filename": str(self.repo.docs.workdir / REQUIREMENT_FILENAME),
                     "prd_filenames": [str(self.repo.docs.prd.workdir / i) for i in self.repo.docs.prd.all_files],
                 },
@@ -183,6 +186,9 @@ class WritePRD(Action):
         kvs["changed_prd_filenames"] = [
             str(self.repo.docs.prd.workdir / i) for i in list(self.repo.docs.prd.changed_files.keys())
         ]
+        kvs["project_path"] = str(self.repo.workdir)
+        kvs["requirements_filename"] = str(self.repo.docs.workdir / REQUIREMENT_FILENAME)
+        self.context.kwargs.project_path = str(self.repo.workdir)
         return AIMessage(
             content="PRD is completed. "
             + "\n".join(
@@ -302,7 +308,7 @@ class WritePRD(Action):
     async def _execute_api(
         self, user_requirement: str, output_path: str, exists_prd_filename: str, extra_info: str
     ) -> AIMessage:
-        content = to_markdown_code_block(val=user_requirement)
+        content = to_markdown_code_block(val=user_requirement, type_="text")
         if extra_info:
             content += to_markdown_code_block(val=extra_info)
 
@@ -320,4 +326,5 @@ class WritePRD(Action):
 
         output_filename = Path(output_path) / f"{uuid.uuid4().hex}.json"
         await awrite(filename=output_filename, data=new_prd.content)
-        return AIMessage(content=f'PRD filename: "{str(output_filename)}"')
+        kvs = AIMessage.create_instruct_value({"changed_prd_filenames": [str(output_filename)]})
+        return AIMessage(content=f'PRD filename: "{str(output_filename)}"', instruct_content=kvs)

metagpt/context.py

@@ -8,7 +8,6 @@
 from __future__ import annotations
 
 import os
-from pathlib import Path
 from typing import Any, Dict, Optional
 
 from pydantic import BaseModel, ConfigDict
@@ -22,8 +21,6 @@ from metagpt.utils.cost_manager import (
     FireworksCostManager,
     TokenCostManager,
 )
-from metagpt.utils.git_repository import GitRepository
-from metagpt.utils.project_repo import ProjectRepo
 
 
 class AttrDict(BaseModel):
@@ -66,9 +63,6 @@ class Context(BaseModel):
     kwargs: AttrDict = AttrDict()
     config: Config = Config.default()
 
-    repo: Optional[ProjectRepo] = None
-    git_repo: Optional[GitRepository] = None
-    src_workspace: Optional[Path] = None
     cost_manager: CostManager = CostManager()
 
     _llm: Optional[BaseLLM] = None
@@ -80,11 +74,6 @@ class Context(BaseModel):
         # env.update({k: v for k, v in i.items() if isinstance(v, str)})
         return env
 
-    def set_repo_dir(self, path: str | Path):
-        repo_path = Path(path)
-        self.git_repo = GitRepository(local_path=repo_path, auto_init=True)
-        self.repo = ProjectRepo(self.git_repo)
-
     def _select_costmanager(self, llm_config: LLMConfig) -> CostManager:
         """Return a CostManager instance"""
         if llm_config.api_type == LLMType.FIREWORKS:
@@ -117,7 +106,6 @@ class Context(BaseModel):
             Dict[str, Any]: A dictionary containing serialized data.
         """
         return {
-            "workdir": str(self.repo.workdir) if self.repo else "",
             "kwargs": {k: v for k, v in self.kwargs.__dict__.items()},
             "cost_manager": self.cost_manager.model_dump_json(),
         }
@@ -130,13 +118,6 @@ class Context(BaseModel):
         """
         if not serialized_data:
             return
-        workdir = serialized_data.get("workdir")
-        if workdir:
-            self.git_repo = GitRepository(local_path=workdir, auto_init=True)
-            self.repo = ProjectRepo(self.git_repo)
-            src_workspace = self.git_repo.workdir / self.git_repo.workdir.name
-            if src_workspace.exists():
-                self.src_workspace = src_workspace
         kwargs = serialized_data.get("kwargs")
         if kwargs:
             for k, v in kwargs.items():

metagpt/environment/base_env.py

@@ -22,6 +22,7 @@ from metagpt.logs import logger
 from metagpt.memory import Memory
 from metagpt.schema import Message
 from metagpt.utils.common import get_function_schema, is_coroutine_func, is_send_to
+from metagpt.utils.git_repository import GitRepository
 
 if TYPE_CHECKING:
     from metagpt.roles.role import Role  # noqa: F401
@@ -243,8 +244,9 @@ class Environment(ExtEnv):
         self.member_addrs[obj] = addresses
 
     def archive(self, auto_archive=True):
-        if auto_archive and self.context.git_repo:
-            self.context.git_repo.archive()
+        if auto_archive and self.context.kwargs.get("project_path"):
+            git_repo = GitRepository(self.context.kwargs.project_path)
+            git_repo.archive()
 
     @classmethod
     def model_rebuild(cls, **kwargs):

metagpt/roles/product_manager.py

@@ -10,7 +10,7 @@
 
 from metagpt.actions import UserRequirement, WritePRD
 from metagpt.actions.prepare_documents import PrepareDocuments
-from metagpt.roles.role import Role
+from metagpt.roles.role import Role, RoleReactMode
 from metagpt.utils.common import any_to_name, any_to_str
 from metagpt.utils.git_repository import GitRepository
 
@@ -35,6 +35,7 @@ class ProductManager(Role):
     def __init__(self, **kwargs) -> None:
         super().__init__(**kwargs)
         self.enable_memory = False
+        self.rc.react_mode = RoleReactMode.BY_ORDER
         self.set_actions([PrepareDocuments(send_to=any_to_str(self)), WritePRD])
         self._watch([UserRequirement, PrepareDocuments])
         self.todo_action = any_to_name(WritePRD)

metagpt/roles/qa_engineer.py

@@ -94,7 +94,7 @@ class QaEngineer(Role):
                 code_filename=context.code_doc.filename,
                 test_filename=context.test_doc.filename,
                 working_directory=str(self.repo.workdir),
-                additional_python_paths=[str(self.context.src_workspace)],
+                additional_python_paths=[str(self.repo.srcs.workdir)],
             )
             self.publish_message(
                 AIMessage(content=run_code_context.model_dump_json(), cause_by=WriteTest, send_to=MESSAGE_ROUTE_TO_SELF)

metagpt/roles/role.py

@@ -386,8 +386,7 @@ class Role(SerializationMixin, ContextMixin, BaseModel):
             msg = response
         else:
             msg = AIMessage(content=response or "", cause_by=self.rc.todo, sent_from=self)
-        if self.enable_memory:
-            self.rc.memory.add(msg)
+        self.rc.memory.add(msg)
 
         return msg
 

metagpt/software_company.py

@@ -68,7 +68,7 @@ def generate_repo(
     company.run_project(idea, send_to=any_to_str(ProductManager))
     asyncio.run(company.run(n_round=n_round))
 
-    return ctx.repo
+    return ctx.kwargs.get("project_path")
 
 
 @app.command("", help="Start a new project.")