From 7b1fbbe2beac5be59af78818e053e7bdb6f42e8e Mon Sep 17 00:00:00 2001 From: TIANYOU CHEN <42710806+CTY-git@users.noreply.github.com> Date: Wed, 16 Apr 2025 12:21:47 +0800 Subject: [PATCH 1/4] add git tool --- patchwork/common/tools/git_tool.py | 44 ++++++++++++++++++++++ patchwork/common/tools/github_tool.py | 2 +- patchwork/steps/GitHubAgent/GitHubAgent.py | 6 ++- 3 files changed, 50 insertions(+), 2 deletions(-) create mode 100644 patchwork/common/tools/git_tool.py diff --git a/patchwork/common/tools/git_tool.py b/patchwork/common/tools/git_tool.py new file mode 100644 index 000000000..4b32765aa --- /dev/null +++ b/patchwork/common/tools/git_tool.py @@ -0,0 +1,44 @@ +from __future__ import annotations + +import os +import subprocess + +from patchwork.common.tools.tool import Tool + + +class GitTool(Tool, tool_name="git_tool", abc_register=False): + def __init__(self, path: str): + super().__init__() + self.path = path + + @property + def json_schema(self) -> dict: + return { + "name": "git_tool", + "description": """\ +Access to the Git CLI, the command is also `git` all args provided are used as is +""", + "input_schema": { + "type": "object", + "properties": { + "args": { + "type": "array", + "items": {"type": "string"}, + "description": "The args to run `git` command with.", + } + }, + "required": ["args"], + }, + } + + def execute(self, args: list[str]) -> str: + env = os.environ.copy() + p = subprocess.run( + ["gh", *args], + env=env, + cwd=self.path, + text=True, + stdout=subprocess.PIPE, + stderr=subprocess.STDOUT, + ) + return p.stdout diff --git a/patchwork/common/tools/github_tool.py b/patchwork/common/tools/github_tool.py index aa5d5effe..16e418c08 100644 --- a/patchwork/common/tools/github_tool.py +++ b/patchwork/common/tools/github_tool.py @@ -6,7 +6,7 @@ from patchwork.common.tools.tool import Tool -class GitHubTool(Tool, tool_name="github_tool"): +class GitHubTool(Tool, tool_name="github_tool", abc_register=False): def __init__(self, path: str, gh_token: str): super().__init__() self.path = path diff --git a/patchwork/steps/GitHubAgent/GitHubAgent.py b/patchwork/steps/GitHubAgent/GitHubAgent.py index bc8d319c1..0ac014538 100644 --- a/patchwork/steps/GitHubAgent/GitHubAgent.py +++ b/patchwork/steps/GitHubAgent/GitHubAgent.py @@ -5,6 +5,7 @@ AgentConfig, AgenticStrategyV2, ) +from patchwork.common.tools.git_tool import GitTool from patchwork.common.tools.github_tool import GitHubTool from patchwork.common.utils.utils import mustache_render from patchwork.step import Step @@ -34,7 +35,10 @@ def __init__(self, inputs): AgentConfig( name="Assistant", model="gemini-2.0-flash", - tool_set=dict(github_tool=GitHubTool(base_path, inputs["github_api_key"])), + tool_set=dict( + github_tool=GitHubTool(base_path, inputs["github_api_key"]), + git_tool=GitTool(base_path), + ), system_prompt="""\ You are a senior software developer helping the program manager to obtain some data from GitHub. You can access github through the `gh` CLI app. From 5bafb638391958f89f114d7d0a7973200d30a9d4 Mon Sep 17 00:00:00 2001 From: TIANYOU CHEN <42710806+CTY-git@users.noreply.github.com> Date: Wed, 16 Apr 2025 12:25:11 +0800 Subject: [PATCH 2/4] bump version --- pyproject.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pyproject.toml b/pyproject.toml index ab89dee54..d136584c5 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "patchwork-cli" -version = "0.0.123" +version = "0.0.124" description = "" authors = ["patched.codes"] license = "AGPL" From c953072cb18039a0d17b007a95f14aafc65414e4 Mon Sep 17 00:00:00 2001 From: TIANYOU CHEN <42710806+CTY-git@users.noreply.github.com> Date: Wed, 16 Apr 2025 13:33:43 +0800 Subject: [PATCH 3/4] fixes --- patchwork/common/tools/git_tool.py | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/patchwork/common/tools/git_tool.py b/patchwork/common/tools/git_tool.py index 4b32765aa..d5acbfa05 100644 --- a/patchwork/common/tools/git_tool.py +++ b/patchwork/common/tools/git_tool.py @@ -16,7 +16,7 @@ def json_schema(self) -> dict: return { "name": "git_tool", "description": """\ -Access to the Git CLI, the command is also `git` all args provided are used as is +Access to the Git CLI, the command is also `git` all args provided are used as is. """, "input_schema": { "type": "object", @@ -24,7 +24,12 @@ def json_schema(self) -> dict: "args": { "type": "array", "items": {"type": "string"}, - "description": "The args to run `git` command with.", + "description": """ +The args to run `git` command with. +E.g. +[\"commit\", \"-m\", \"A commit message\"] to commit changes with a commit message. +[\"add\", \".\"] to stage all changed files. +""", } }, "required": ["args"], @@ -34,7 +39,7 @@ def json_schema(self) -> dict: def execute(self, args: list[str]) -> str: env = os.environ.copy() p = subprocess.run( - ["gh", *args], + ["git", *args], env=env, cwd=self.path, text=True, From 75648ffa4c8b6cb32a4d6fb642963efa1c065109 Mon Sep 17 00:00:00 2001 From: "patched.codes[bot]" <298395+patched.codes[bot]@users.noreply.github.com> Date: Wed, 16 Apr 2025 05:43:21 +0000 Subject: [PATCH 4/4] Patched patchwork/steps/ManageEngineAgent/README.md --- patchwork/steps/ManageEngineAgent/README.md | 50 +++++++++++++++++++++ 1 file changed, 50 insertions(+) create mode 100644 patchwork/steps/ManageEngineAgent/README.md diff --git a/patchwork/steps/ManageEngineAgent/README.md b/patchwork/steps/ManageEngineAgent/README.md new file mode 100644 index 000000000..9e3e4e050 --- /dev/null +++ b/patchwork/steps/ManageEngineAgent/README.md @@ -0,0 +1,50 @@ +# ManageEngineAgent Code Documentation + +## Overview + +The `ManageEngineAgent` module is part of a larger framework and facilitates interactions with the ManageEngine ServiceDesk API by utilizing advanced AI models to assist in ticket management through API requests. This implementation relies on a strategic AI-driven approach to handle conversations and API interactions, aiming to streamline service desk operations. + +## File Structure + +- **typed.py**: Defines input and output types for the `ManageEngineAgent` using Python's `TypedDict` for structured data annotations. +- **__init__.py**: An empty initialization file that allows the directory to be treated as a package. +- **ManageEngineAgent.py**: The core of the module where the `ManageEngineAgent` class is implemented, leveraging AI and API tools for efficient service desk management. + +## Inputs + +Defined in `typed.py` as part of the `ManageEngineAgentInputs` class: + +### Required + +- `zoho_access_token`: A string representing the Zoho authentication token to authorize API requests. +- `user_prompt`: A string to guide the AI interaction and provide context for the tasks to be accomplished. +- `prompt_value`: A dictionary containing dynamic information to be used in the user prompt. + +### Optional + +- `max_agent_calls`: An integer that limits the number of API calls during a session. +- `openai_api_key`, `anthropic_api_key`, `google_api_key`: Keys that specify which AI model to use for generating conversational and strategic responses, considering mutual exclusivity. +- `system_prompt`: An optional string to refine the AI's overarching conversation context. +- `example_json`: An optional dictionary for example data used in training or AI-response generation. + +## Outputs + +Defined in `typed.py` as part of the `ManageEngineAgentOutputs` class: + +- `conversation_history`: A list of dictionaries representing the history of the AI-driven conversations. +- `tool_records`: A list of dictionaries documenting the interactions with the ManageEngine API. +- `request_tokens`: An integer indicating the number of tokens used in requests. +- `response_tokens`: An integer indicating the number of tokens generated in responses. + +## Key Features + +- **AI-Driven API Interactions**: The `ManageEngineAgent` uses a state-of-the-art conversational AI model to automate interactions with the ManageEngine ServiceDesk API. +- **Configurable Strategy**: Offers flexibility in selecting AI models and configuring API call limits to suit different operational needs. +- **Template-Driven Input Handling**: Utilizes `mustache_render` for dynamic user prompts and system messages, ensuring context-relevant interactions. + +## Example Use Case + +- **Automating Service Desk Tasks**: Integrate this agent into an IT service workflow to automate tasks such as ticket retrieval, updates, and creation via ManageEngine's ServiceDesk API. +- **AI-Augmented Decision Support**: Use configured conversation strategies to provide AI recommendations alongside operational reports to decision-makers. + +By structuring the code using Python’s `TypedDict` and leveraging advanced AI strategies, the `ManageEngineAgent` module provides robust support for intelligent service management operations.