Merge pull request #75 from nforro/tools

Clearly indicate a successful tool run

Author: nforro

beeai/agents/tests/unit/test_tools.py

@@ -104,7 +104,7 @@ async def test_add_changelog_entry(minimal_spec):
         input=AddChangelogEntryToolInput(spec=minimal_spec, content=content, author=author, email=email)
     ).middleware(GlobalTrajectoryMiddleware(pretty=True))
     result = output.result
-    assert not result
+    assert result.startswith("Successfully")
     assert minimal_spec.read_text().splitlines()[-7:-2] == [
         "%changelog",
         "* Tue Aug 05 2025 rhel-packaging-agent <[email protected]> - 0.1-2",
@@ -121,7 +121,7 @@ async def test_bump_release(minimal_spec):
         GlobalTrajectoryMiddleware(pretty=True)
     )
     result = output.result
-    assert not result
+    assert result.startswith("Successfully")
     assert minimal_spec.read_text().splitlines()[3] == "Release:        3%{?dist}"
 
 
@@ -157,7 +157,7 @@ async def test_set_zstream_release(autorelease_spec):
         input=SetZStreamReleaseToolInput(spec=autorelease_spec, latest_ystream_evr=latest_ystream_evr)
     ).middleware(GlobalTrajectoryMiddleware(pretty=True))
     result = output.result
-    assert not result
+    assert result.startswith("Successfully")
     assert autorelease_spec.read_text().splitlines()[3] == "Release:        4%{?dist}.%{autorelease -n}"
 
 
@@ -170,7 +170,7 @@ async def test_create(tmp_path):
         GlobalTrajectoryMiddleware(pretty=True)
     )
     result = output.result
-    assert not result
+    assert result.startswith("Successfully")
     assert test_file.read_text() == content
 
 
@@ -255,7 +255,7 @@ async def test_insert(line, content, tmp_path):
         input=InsertToolInput(file=test_file, line=line, new_string="Inserted line")
     ).middleware(GlobalTrajectoryMiddleware(pretty=True))
     result = output.result
-    assert not result
+    assert result.startswith("Successfully")
     assert test_file.read_text() == content
 
 
@@ -268,7 +268,7 @@ async def test_str_replace(tmp_path):
         input=StrReplaceToolInput(file=test_file, old_string="Line 2", new_string="LINE_2")
     ).middleware(GlobalTrajectoryMiddleware(pretty=True))
     result = output.result
-    assert not result
+    assert result.startswith("Successfully")
     assert (
         test_file.read_text()
         == dedent(

beeai/agents/tools/specfile.py

@@ -30,7 +30,7 @@ class AddChangelogEntryToolInput(BaseModel):
 class AddChangelogEntryTool(Tool[AddChangelogEntryToolInput, ToolRunOptions, StringToolOutput]):
     name = "add_changelog_entry"
     description = """
-    Adds a new changelog entry to the specified spec file. Returns error message on failure.
+    Adds a new changelog entry to the specified spec file.
     """
     input_schema = AddChangelogEntryToolInput
 
@@ -48,7 +48,7 @@ async def _run(
                 spec.add_changelog_entry(tool_input.content, author=tool_input.author, email=tool_input.email)
         except Exception as e:
             return StringToolOutput(result=f"Failed to add changelog entry: {e}")
-        return StringToolOutput()
+        return StringToolOutput(result=f"Successfully added a new changelog entry to {tool_input.spec}")
 
 
 class BumpReleaseToolInput(BaseModel):
@@ -59,7 +59,6 @@ class BumpReleaseTool(Tool[BumpReleaseToolInput, ToolRunOptions, StringToolOutpu
     name = "bump_release"
     description = """
     Bumps (increments) the value of `Release` in the specified spec file.
-    Returns error message on failure.
     """
     input_schema = BumpReleaseToolInput
 
@@ -77,7 +76,7 @@ async def _run(
                 spec.bump_release()
         except Exception as e:
             return StringToolOutput(result=f"Failed to bump release: {e}")
-        return StringToolOutput()
+        return StringToolOutput(result=f"Successfully bumped release in {tool_input.spec}")
 
 
 class SetZStreamReleaseToolInput(BaseModel):
@@ -90,7 +89,6 @@ class SetZStreamReleaseTool(Tool[SetZStreamReleaseToolInput, ToolRunOptions, Str
     description = """
     Sets the value of the `Release` field in the specified spec file to a Z-Stream release
     based on the release of the latest Y-Stream build.
-    Returns error message on failure.
     """
     input_schema = SetZStreamReleaseToolInput
 
@@ -112,4 +110,4 @@ async def _run(
                 spec.raw_release = base_raw_release + "%{?dist}.%{autorelease -n}"
         except Exception as e:
             return StringToolOutput(result=f"Failed to set Z-Stream release: {e}")
-        return StringToolOutput()
+        return StringToolOutput(result=f"Successfully set Z-Stream release in {tool_input.spec}")

beeai/agents/tools/text.py

@@ -17,7 +17,6 @@ class CreateTool(Tool[CreateToolInput, ToolRunOptions, StringToolOutput]):
     name = "create"
     description = """
     Creates a new file with the specified content.
-    Returns error message on failure.
     """
     input_schema = CreateToolInput
 
@@ -34,7 +33,7 @@ async def _run(
             await asyncio.to_thread(tool_input.file.write_text, tool_input.content)
         except Exception as e:
             return StringToolOutput(result=f"Failed to create file: {e}")
-        return StringToolOutput()
+        return StringToolOutput(result=f"Successfully created {tool_input.file} with the specified text")
 
 
 class ViewToolInput(BaseModel):
@@ -60,7 +59,7 @@ class ViewTool(Tool[ViewToolInput, ToolRunOptions, StringToolOutput]):
     name = "view"
     description = """
     Outputs the contents of a file or lists the contents of a directory. Can read an entire file
-    or a specific range of lines. Returns error message on failure.
+    or a specific range of lines.
     """
     input_schema = ViewToolInput
 
@@ -96,7 +95,6 @@ class InsertTool(Tool[InsertToolInput, ToolRunOptions, StringToolOutput]):
     name = "insert"
     description = """
     Inserts the specified text at a specific location in a file.
-    Returns error message on failure.
     """
     input_schema = InsertToolInput
 
@@ -115,7 +113,7 @@ async def _run(
             await asyncio.to_thread(tool_input.file.write_text, "".join(lines))
         except Exception as e:
             return StringToolOutput(result=f"Failed to insert text: {e}")
-        return StringToolOutput()
+        return StringToolOutput(result=f"Successfully inserted the specified text into {tool_input.file}")
 
 
 class StrReplaceToolInput(BaseModel):
@@ -130,7 +128,6 @@ class StrReplaceTool(Tool[StrReplaceToolInput, ToolRunOptions, StringToolOutput]
     name = "str_replace"
     description = """
     Replaces a specific string in the specified file with a new string.
-    Returns error message on failure.
     """
     input_schema = StrReplaceToolInput
 
@@ -150,4 +147,4 @@ async def _run(
             )
         except Exception as e:
             return StringToolOutput(result=f"Failed to replace text: {e}")
-        return StringToolOutput()
+        return StringToolOutput(result=f"Successfully replaced the specified text in {tool_input.file}")

beeai/mcp_server/gitlab_tools.py

@@ -51,10 +51,9 @@ def push_to_remote_repository(
     clone_path: Annotated[Path, Field(description="Absolute path to local clone of the repository")],
     branch: Annotated[str, Field(description="Branch to push")],
     force: Annotated[bool, Field(description="Whether to overwrite the remote ref")] = False,
-) -> str | None:
+) -> str:
     """
     Pushes the specified branch from a local clone to the specified remote repository.
-    Returns error message on failure.
     """
     url = urlparse(repository)
     token = os.getenv("GITLAB_TOKEN")
@@ -64,3 +63,4 @@ def push_to_remote_repository(
         command.append("--force")
     if subprocess.run(command, cwd=clone_path).returncode != 0:
         return "Failed to push to the specified repository"
+    return f"Successfully pushed the specified branch to {repository}"

beeai/mcp_server/jira_tools.py

@@ -64,10 +64,9 @@ def set_jira_fields(
     preliminary_testing: Annotated[
         PreliminaryTesting | None, Field(description="Preliminary Testing value")
     ] = None,
-) -> str | None:
+) -> str:
     """
     Updates the specified Jira issue, setting the specified fields (if provided).
-    Returns error message on failure.
     """
     fields = {}
     if fix_versions is not None:
@@ -77,7 +76,7 @@ def set_jira_fields(
     if preliminary_testing is not None:
         fields["customfield_12321540"] = {"value": preliminary_testing.value}
     if not fields:
-        return
+        return "No fields to update have been specified, not doing anything"
     try:
         response = requests.put(
             urljoin(os.getenv("JIRA_URL"), f"rest/api/2/issue/{issue_key}"),
@@ -87,14 +86,15 @@ def set_jira_fields(
         response.raise_for_status()
     except requests.RequestException as e:
         return f"Failed to set the specified fields: {e}"
+    return f"Successfully set the specified fields in {issue_key}"
 
 
 def add_jira_comment(
     issue_key: Annotated[str, Field(description="Jira issue key (e.g. RHEL-12345)")],
     comment: Annotated[str, Field(description="Comment text to add")],
-) -> str | None:
+) -> str:
     """
-    Adds a comment to the specified Jira issue. Returns error message on failure.
+    Adds a comment to the specified Jira issue.
     """
     try:
         response = requests.post(
@@ -105,3 +105,4 @@ def add_jira_comment(
         response.raise_for_status()
     except requests.RequestException as e:
         return f"Failed to add the specified comment: {e}"
+    return f"Successfully added the specified comment to {issue_key}"

beeai/mcp_server/lookaside_tools.py

@@ -10,26 +10,28 @@
 def download_sources(
     dist_git_path: Annotated[Path, Field(description="Path to cloned dist-git repository")],
     internal: Annotated[bool, Field(description="Whether to use internal RHEL dist-git instead of CentOS Stream one")] = False,
-) -> str | None:
+) -> str:
     """
-    Downloads sources from lookaside cache. Returns error message on failure.
+    Downloads sources from lookaside cache.
     """
     tool = "rhpkg" if internal else "centpkg"
     if subprocess.run([tool, "sources"], cwd=dist_git_path).returncode != 0:
         return "Failed to download sources"
+    return "Successfully downloaded sources from lookaside cache"
 
 
 def upload_sources(
     dist_git_path: Annotated[Path, Field(description="Path to cloned dist-git repository")],
     new_sources: Annotated[list[str], Field(description="List of new sources (file names) to upload")],
     internal: Annotated[bool, Field(description="Whether to use internal RHEL dist-git instead of CentOS Stream one")] = False,
-) -> str | None:
+) -> str:
     """
     Uploads the specified sources to lookaside cache. Also updates the `sources` and `.gitignore` files
-    accordingly and adds them to git index. Returns error message on failure.
+    accordingly and adds them to git index.
     """
     tool = "rhpkg" if internal else "centpkg"
     if not init_kerberos_ticket():
         return "Failed to initialize Kerberos ticket"
     if subprocess.run([tool, "new-sources", *new_sources], cwd=dist_git_path).returncode != 0:
         return "Failed to upload sources"
+    return "Successfully uploaded the specified new sources to lookaside cache"

beeai/mcp_server/tests/unit/test_gitlab_tools.py

@@ -53,4 +53,5 @@ def run(cmd, **kwargs):
         return flexmock(returncode=0)
 
     flexmock(subprocess).should_receive("run").replace_with(run)
-    assert push_to_remote_repository(repository=repository, clone_path=clone_path, branch=branch) is None
+    result = push_to_remote_repository(repository=repository, clone_path=clone_path, branch=branch)
+    assert result.startswith("Successfully")

beeai/mcp_server/tests/unit/test_jira_tools.py

@@ -57,7 +57,8 @@ def put(url, json, headers):
         return flexmock(raise_for_status=lambda: None)
 
     flexmock(requests).should_receive("put").replace_with(put)
-    assert set_jira_fields(issue_key, **args) is None
+    result = set_jira_fields(issue_key, **args)
+    assert result.startswith("Successfully")
 
 
 def test_add_jira_comment():
@@ -70,4 +71,5 @@ def post(url, json, headers):
         return flexmock(raise_for_status=lambda: None)
 
     flexmock(requests).should_receive("post").replace_with(post)
-    assert add_jira_comment(issue_key, comment) is None
+    result = add_jira_comment(issue_key, comment)
+    assert result.startswith("Successfully")

beeai/mcp_server/tests/unit/test_lookaside.py

@@ -17,7 +17,8 @@ def run(cmd, **kwargs):
         return flexmock(returncode=0)
 
     flexmock(subprocess).should_receive("run").replace_with(run)
-    assert download_sources(dist_git_path=".", internal=internal) is None
+    result =  download_sources(dist_git_path=".", internal=internal)
+    assert result.startswith("Successfully")
 
 
 @pytest.mark.parametrize(
@@ -32,4 +33,5 @@ def run(cmd, **kwargs):
 
     flexmock(lookaside_tools).should_receive("init_kerberos_ticket").and_return(True).once()
     flexmock(subprocess).should_receive("run").replace_with(run)
-    assert upload_sources(dist_git_path=".", new_sources=new_sources, internal=internal) is None
+    result =  upload_sources(dist_git_path=".", new_sources=new_sources, internal=internal)
+    assert result.startswith("Successfully")