Skip to content

Commit 17caa18

Browse files
radu-mocanuradu-mocanu
committed
chore: added readmes for samples
1 parent 62916de commit 17caa18

File tree

8 files changed

+175
-5
lines changed

8 files changed

+175
-5
lines changed

‎README.md‎

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,7 @@
66

77
A Python SDK that enables hosting local MCP servers on UiPath Platform.
88

9-
Check out these sample projects to get started:
10-
11-
- [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
12-
- [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
13-
9+
Check out our [samples directory](https://github.com/UiPath/uipath-mcp-python/tree/main/samples) to explore various MCP server implementations. You can also learn how to [pack and host binary servers](https://github.com/UiPath/uipath-mcp-python/blob/main/docs/how_to_pack_binary.md) written in languages like Go within UiPath.
1410

1511
## Installation
1612

‎samples/README.md‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Project Samples
2+
3+
## [GitHub Helper Agent](github-helper-agent)
4+
A sample MCP server that demonstrates how to build, pack, and publish executable MCP Servers created in Go, showcasing integration with GitHub APIs.
5+
6+
## [GitHub Slack Agent](github-slack-agent)
7+
An agent that integrates GitHub with Slack, demonstrating how to build cross-platform automation workflows using MCP servers.
8+
9+
## [Math MCP Server](mcp-math-server)
10+
A simple example showing how to create a custom Python MCP server that provides mathematical operations.
11+
12+
## [MCP Dynamic Server](mcp-dynamic-server)
13+
Demonstrates how to create a dynamic MCP server that can adapt its behavior and tools based on runtime conditions.
14+
15+
## [MCP Functions Agent](mcp-functions-agent)
16+
Shows how to create an agent that can execute custom functions through the MCP protocol.
17+
18+
## [MCP Functions Server](mcp-functions-server)
19+
A companion server implementation showcasing how to expose custom functions as MCP tools.
20+
21+
## [MCP SDK Server](mcp-sdk-server)
22+
An MCP server that exposes UiPath SDK functionality, enabling AI agents to interact with UiPath Platform features using natural language.
23+
24+
## [Financial Reconciliation Agent](financial-reconciliation-agent)
25+
An example of how to build a specialized agent for financial data reconciliation tasks.
26+
27+
## [MCP Insights](mcp-insights)
28+
Tools and utilities for gathering insights and metrics from MCP server operations.

‎samples/github-slack-agent/README.md‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
# GitHub-Slack Integration Agent
2+
3+
An advanced integration agent that connects GitHub and Slack, providing automated code review notifications and insights. This agent demonstrates cross-platform automation using multiple MCP servers.
4+
5+
## Features
6+
- Automated PR reviews posted to Slack
7+
- Detailed code analysis and feedback
8+
- Threaded discussions in Slack
9+
- Integration with both GitHub and Slack MCP servers
10+
- Professional formatting for Slack messages
11+
12+
## Requirements
13+
- Python >=3.11
14+
- `langchain-mcp-adapters`
15+
- `langgraph`
16+
- `uipath-langchain`
17+
- Access to GitHub and Slack MCP servers
18+
19+
## Configuration
20+
Set the following environment variables in `.env`:
21+
```bash
22+
GITHUB_MCP_SERVER_URL=your_github_mcp_url
23+
SLACK_MCP_SERVER_URL=your_slack_mcp_url
24+
SLACK_CHANNEL_ID=your_channel_id
25+
UIPATH_ACCESS_TOKEN=your_access_token
26+
```
27+
28+
## Usage
29+
The agent automatically:
30+
1. Monitors GitHub pull requests
31+
2. Performs code review analysis
32+
3. Posts formatted messages to Slack
33+
4. Creates threaded discussions for detailed feedback
34+
35+
## Message Format
36+
Messages in Slack follow this structure:
37+
```
38+
🧠 Summary:
39+
Brief explanation of the PR
40+
41+
✅ Pros:
42+
• Code strengths
43+
• Architecture improvements
44+
45+
❌ Issues:
46+
• Specific file and line references
47+
• Detailed problem descriptions
48+
49+
💡 Suggestions:
50+
• Improvement recommendations
51+
• Code examples
52+
```

‎samples/mcp-dynamic-server/README.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Dynamic MCP Server
2+
3+
A self-extending MCP server that can dynamically add new tools at runtime.
4+
5+
## Features
6+
- Dynamic tool addition at runtime
7+
- Self-extending capabilities
8+
- Tool validation and registration
9+
- Runtime code evaluation
10+
- Secure tool execution environment
11+
12+
## Requirements
13+
- Python >=3.11
14+
- UiPath MCP SDK

‎samples/mcp-functions-agent/README.md‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# MCP Functions Agent
2+
3+
An agent that works with the MCP Functions Server to create, test, and execute Python functions dynamically.
4+
5+
## Features
6+
- AI-powered function generation
7+
- Automated test creation
8+
- Dynamic code validation
9+
- Integration with MCP Functions Server
10+
- Smart error handling and debugging
11+
12+
## Requirements
13+
- Python >=3.11
14+
- `uipath-langchain`
15+
- `langgraph`
16+
- `langchain-mcp-adapters`
17+
- Access to MCP Functions Server
18+
19+
## Configuration
20+
Set up your environment variables in `.env`:
21+
```bash
22+
FUNCTIONS_MCP_SERVER_URL=your_functions_server_url
23+
UIPATH_ACCESS_TOKEN=your_access_token
24+
```
25+
26+
## Usage
27+
The agent can:
28+
1. Analyze natural language function requests
29+
2. Generate appropriate Python code
30+
3. Create comprehensive test cases
31+
4. Validate and execute the functions
32+
5. Provide detailed feedback on results
33+
34+
## Example
35+
```bash
36+
uipath run agent '{"query": "Create a function that calculates the factorial of a number"}'
37+
```

‎samples/mcp-functions-server/README.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# MCP Functions Server
2+
3+
An MCP server that enables dynamic creation and execution of Python functions.
4+
5+
## Features
6+
- Dynamic function creation
7+
- Runtime code evaluation
8+
- Function validation and security checks
9+
- Flexible input/output schema handling
10+
- Integration with MCP Functions Agent
11+
12+
## Requirements
13+
- Python >=3.11
14+
- UiPath MCP SDK

‎samples/mcp-math-server/README.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Math MCP Server
2+
3+
A simple example demonstrating how to create a custom Python MCP server that provides mathematical operations.
4+
5+
## Features
6+
- Basic arithmetic operations
7+
- Advanced mathematical functions
8+
- Example of proper tool documentation
9+
- Clean implementation of MCP server tools
10+
11+
## Requirements
12+
- Python >=3.11
13+
- UiPath MCP SDK
14+

‎samples/mcp-sdk-server/README.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# MCP SDK Server
2+
3+
A sample MCP server that exposes UiPath SDK functionality through the MCP protocol. This enables AI agents to interact with UiPath Platform features using natural language.
4+
5+
## Features
6+
- Access to UiPath SDK capabilities via MCP
7+
- Integration with UiPath Platform services
8+
- Automation operations through MCP tools
9+
- Platform authentication and authorization
10+
- Secure SDK access management
11+
12+
## Requirements
13+
- Python >=3.11
14+
- UiPath MCP SDK
15+
- UiPath Platform access

0 commit comments

Comments
 (0)