You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/quick_start.md
+24-19Lines changed: 24 additions & 19 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,13 +6,12 @@ This guide provides step-by-step instructions for setting up, creating, publishi
6
6
7
7
## Prerequisites
8
8
9
-
Before proceeding, ensure you have the following installed:
9
+
Before proceeding, ensure you have the following prerequisites:
10
10
11
11
- Python 3.11 or higher
12
12
-`pip` or `uv` package manager
13
13
- A UiPath Automation Cloud account with appropriate permissions
14
14
- A [UiPath Personal Access Token](https://docs.uipath.com/automation-cloud/automation-cloud/latest/api-guide/personal-access-tokens) with _Orchestrator API Access scopes_
15
-
- A folder in Orchestrator with a serverless runtime (machine) assigned to it
16
15
17
16
## Creating a New Project
18
17
@@ -223,12 +222,20 @@ You can inspect the available tools by clicking on the server:
223
222
224
223
Now we can connect to the server using any MCP client. See the [Connecting to the MCP Server](#connecting-to-the-mcp-server) section.
225
224
226
-
/// warning
227
-
Before running the MCP server, ensure that a serverless runtime (machine) is assigned to your folder in Orchestrator.
228
-
///
229
-
230
225
### 2. Running on UiPath Cloud Platform
231
226
227
+
/// Info
228
+
This quickstart guide provides instructions for deploying the MCP Server in My Workspace folder. Choosing this folder simplifies the configuration process, as you won’t need to manually handle the following:
229
+
- Serverless machine allocation
230
+
- Unattended robot permissions
231
+
- Process creation (processes are automatically auto-provisioned upon publishing a package to My Workspace)
232
+
233
+
If you prefer to deploy the MCP Server in a different folder, additional steps will be required:
234
+
1. Create a process from the MCP Server package.
235
+
2. Ensure a [serverless runtime (machine)](https://docs.uipath.com/orchestrator/automation-cloud/latest/user-guide/executing-unattended-automations-with-serverless-robots) is assigned to the target folder in Orchestrator.
236
+
3. Confirm that a user with [unattended robot permissions](https://docs.uipath.com/robot/standalone/2024.10/admin-guide/unattended-automations) is assigned to the target folder.
237
+
///
238
+
232
239
To deploy your MCP server to UiPath Cloud Platform, follow these steps:
233
240
234
241
#### (Optional) Customize the Package
@@ -256,25 +263,23 @@ Authors : John Doe
256
263
257
264
<!-- termynal -->
258
265
```shell
259
-
> uipath publish
260
-
⠏ Fetching available package feeds...
261
-
👇 Select package feed:
262
-
0: Orchestrator Tenant Processes Feed
263
-
1: Folder Feed 1
264
-
2: Folder Feed 2
265
-
...
266
-
Select feed number: 0
267
-
Selected feed: Orchestrator Tenant Processes Feed
268
-
⠸ Publishing most recent package: math-server.0.0.1.nupkg ...
266
+
> uipath publish --my-workspace
267
+
⠙ Publishing most recent package: math-server.0.0.1.nupkg ...
269
268
✓ Package published successfully!
269
+
⠦ Getting process information ...
270
+
🔗 Process configuration link: [LINK]
271
+
💡 Use the link above to configure any environment variables
270
272
```
271
273
272
274
After publishing, you can configure and manage your MCP server through the UiPath Cloud interface:
273
275
274
276
#### Configure in UiPath Cloud
275
277
276
-
1. In Orchestrator, create a new Process using your published MCP Server package as the template
277
-
2. In the folder where you want to deploy the server, navigate to the MCP Servers tab and click **Add MCP Server**
278
+
1. In the folder where you want to deploy the server, navigate to the MCP Servers tab and click **Add MCP Server**
279
+
280
+
/// info
281
+
Please note that a process will be auto-created only upon publishing to **my-workspace** package feed.
0 commit comments