Skip to content

Commit 278687a

Browse files
committed
docs: update github agent
1 parent ad6aaf8 commit 278687a

File tree

3 files changed

+22
-7
lines changed

3 files changed

+22
-7
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,8 @@ UIPATH_ACCESS_TOKEN=YOUR_TOKEN_HERE
3131

3232
### Servers Definition
3333

34+
Create the `mcp.json` file:
3435
```json
35-
// mcp.json
3636
{
3737
"servers": {
3838
"my-python-server": {

docs/how_to_pack_binary.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# How to pack and publish the official GitHub MCP Server
1+
# How to pack and publish the GitHub MCP Server
22

3-
This guide walks you through manually packaging and publishing the GitHub MCP server to UiPath Orchestrator. An [example GitHub Actions workflow](/.github/workflows/build-github-mcp-server.yml) is provided to automate these steps.
3+
This guide walks you through manually packaging and publishing the official [GitHub MCP server](https://github.com/github/github-mcp-server) to UiPath Orchestrator. An [example GitHub Actions workflow](/.github/workflows/build-github-mcp-server.yml) is provided to automate these steps.
44

55
## Prerequisites
66

samples/github-helper-agent/README.md

Lines changed: 19 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,19 @@ The agent uses:
88
- LangGraph for orchestration
99
- UiPath hosted GitHub MCP server
1010

11+
The agent consists of three main components:
12+
13+
1. [GitHub action to deploy](https://github.com/UiPath/uipath-mcp-python/blob/main/docs/how_to_pack_binary.md) the official GitHub MCP Server to UiPath
14+
2. [GitHub action](https://github.com/UiPath/uipath-mcp-python/blob/main/.github/workflows/trigger-github-agent.yml) that triggers this agent on "/help <command>"
15+
3. The GitHub helper agent itself with developer and reviewer nodes
16+
17+
## Command Structure
18+
19+
The agent responds to the following commands:
20+
21+
- Reviewer: `/help suggest`, `/help review`, `/help test`
22+
- Developer: `/help commit` (commits the latest suggestion/review/tests)
23+
1124
## Architecture
1225

1326
```mermaid
@@ -64,7 +77,7 @@ uv venv -p 3.11 .venv
6477
uv sync
6578
```
6679

67-
Set your MCP Remote Server URL as environment variables in .env
80+
Set your MCP Remote Server URL as environment variables in `.env`:
6881

6982
```bash
7083
UIPATH_MCP_SERVER_URL=https://cloud.uipath.com/account/tenant/mcp_/mcp/folder-key/github-mcp/sse
@@ -75,8 +88,10 @@ UIPATH_MCP_SERVER_URL=https://cloud.uipath.com/account/tenant/mcp_/mcp/folder-ke
7588
For debugging issues:
7689

7790
1. Check logs for any connection or runtime errors:
78-
```bash
79-
uipath run agent '{"owner": "uipath", "repo": "uipath-mcp-python", "pullNumber": 78, "command": "summarize", "in_reply_to": 2060859623}'
80-
```
91+
```bash
92+
uipath run agent '{"owner": "uipath", "repo": "uipath-mcp-python", "pullNumber": 78, "command": "summarize", "in_reply_to": 2060859623}'
93+
```
94+
2. Verify that the GitHub MCP Server is properly deployed and accessible.
95+
3. Check GitHub Action logs for any issues with command triggers.
8196

8297

0 commit comments

Comments
 (0)