diff --git a/README.md b/README.md index 17ec827..c4d6b10 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,12 @@ A Python SDK that enables hosting local MCP servers on UiPath Platform. +Check out these sample projects to get started: + +- [GitHub MCP Server (Go)](https://github.com/UiPath/uipath-mcp-python/tree/main/samples/github-helper-agent) - Build, pack and publish executable MCP Servers created in Go +- [Math MCP Server (Python)](https://github.com/UiPath/uipath-mcp-python/tree/main/samples/mcp-math-server) - Pack and publish custom Python code MCP Server + + ## Installation ```bash @@ -20,19 +26,10 @@ uv add uipath-mcp ## Configuration -### Environment Variables - -Create a `.env` file in your project root with the following variables: - -``` -UIPATH_URL=https://cloud.uipath.com/ACCOUNT_NAME/TENANT_NAME -UIPATH_ACCESS_TOKEN=YOUR_TOKEN_HERE -``` - ### Servers Definition +Create the `mcp.json` file: ```json -// mcp.json { "servers": { "my-python-server": { diff --git a/docs/how_to_pack_binary.md b/docs/how_to_pack_binary.md index a4d903b..0fa476d 100644 --- a/docs/how_to_pack_binary.md +++ b/docs/how_to_pack_binary.md @@ -1,6 +1,6 @@ -# How to pack and publish the official GitHub MCP Server +# How to pack and publish the GitHub MCP Server -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. +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. ## Prerequisites diff --git a/samples/github-helper-agent/README.md b/samples/github-helper-agent/README.md index 48a58d5..01ea7ea 100644 --- a/samples/github-helper-agent/README.md +++ b/samples/github-helper-agent/README.md @@ -8,6 +8,19 @@ The agent uses: - LangGraph for orchestration - UiPath hosted GitHub MCP server +The agent consists of three main components: + +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 +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" +3. The GitHub helper agent itself with developer and reviewer nodes + +## Command Structure + +The agent responds to the following commands: + +- Reviewer: `/help suggest`, `/help review`, `/help test` +- Developer: `/help commit` (commits the latest suggestion/review/tests) + ## Architecture ```mermaid @@ -64,7 +77,7 @@ uv venv -p 3.11 .venv uv sync ``` -Set your MCP Remote Server URL as environment variables in .env +Set your MCP Remote Server URL as environment variables in `.env`: ```bash 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 For debugging issues: 1. Check logs for any connection or runtime errors: - ```bash - uipath run agent '{"owner": "uipath", "repo": "uipath-mcp-python", "pullNumber": 78, "command": "summarize", "in_reply_to": 2060859623}' - ``` +```bash +uipath run agent '{"owner": "uipath", "repo": "uipath-mcp-python", "pullNumber": 78, "command": "summarize", "in_reply_to": 2060859623}' +``` +2. Verify that the GitHub MCP Server is properly deployed and accessible. +3. Check GitHub Action logs for any issues with command triggers.