Skip to content

Commit 10e2e16

Browse files
authored
Update quick_start.md
* use present tense and avoid future tense unless necessary * Automation Cloud instead of Cloud Platform * reduce wordiness * what's windows bash? is it a thing?
1 parent e7c5211 commit 10e2e16

File tree

1 file changed

+21
-20
lines changed

1 file changed

+21
-20
lines changed

docs/quick_start.md

Lines changed: 21 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22

33
## Introduction
44

5-
This guide provides step-by-step instructions for setting up, creating, publishing, and running your first UiPath coded MCP Server.
5+
This guide provides instructions for setting up and running a UiPath coded MCP Server.
66

77
## Prerequisites
88

9-
Before proceeding, ensure you have the following prerequisites:
9+
You need:
1010

1111
- Python 3.11 or higher
1212
- `pip` or `uv` package manager
@@ -15,7 +15,7 @@ Before proceeding, ensure you have the following prerequisites:
1515

1616
## Creating a New Project
1717

18-
We recommend using `uv` for package management. To create a new project:
18+
Use `uv` for package management. To create a new project:
1919

2020
//// tab | Linux, macOS, Windows Bash
2121

@@ -90,7 +90,7 @@ Activate with: source .venv/bin/activate
9090

9191
## Create Your First UiPath Coded MCP Server
9292

93-
Generate your first UiPath LangChain agent:
93+
Create your first MCP server
9494

9595
<!-- termynal -->
9696

@@ -108,6 +108,10 @@ Start 'math-server' as a self-hosted MCP server
108108
💡 2. Start the server locally: uipath run math-server
109109
```
110110

111+
/// warning
112+
_uipath new_ command deletes all previous `.py` files in the current directory.
113+
///
114+
111115
This command creates the following files:
112116

113117
| File Name | Description |
@@ -116,9 +120,6 @@ This command creates the following files:
116120
| `mcp.json` | Configuration file needed for coded UiPath MCP Servers. |
117121
| `pyproject.toml` | Project metadata and dependencies as per [PEP 518](https://peps.python.org/pep-0518/). |
118122

119-
/// warning
120-
_uipath new_ command will delete all previous `.py` files in the current directory.
121-
///
122123

123124
## Initialize Project
124125

@@ -135,7 +136,7 @@ This command creates the following files:
135136

136137
| File Name | Description |
137138
| ---------------- | --------------------------------------------------------------------------------------------------------------------------------- |
138-
| `.env` | Environment variables and secrets (this file will not be packed & published). |
139+
| `.env` | Environment variables and secrets (this file is not packed & published). |
139140
| `uipath.json` | Input/output JSON schemas and bindings. |
140141

141142
## Authenticate With UiPath
@@ -196,7 +197,7 @@ Registering server runtime ...
196197

197198
#### Verifying the Server
198199

199-
Once started successfully, your MCP server will appear in Orchestrator. Navigate to the MCP Servers tab in your configured folder:
200+
Once started successfully, your MCP server will appear in Orchestrator. Navigate to the **MCP Servers** tab in your configured folder:
200201

201202
<picture data-light="../quick_start_images/self-hosted-light.png" data-dark="../quick_start_images/self-hosted-dark.png">
202203
<source
@@ -222,7 +223,7 @@ You can inspect the available tools by clicking on the server:
222223

223224
Now we can connect to the server using any MCP client. See the [Connecting to the MCP Server](#connecting-to-the-mcp-server) section.
224225

225-
### 2. Running on UiPath Cloud Platform
226+
### 2. Running on UiPath Automation Cloud
226227

227228
/// Info
228229
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:
@@ -233,7 +234,7 @@ This quickstart guide provides instructions for deploying the MCP Server in _My
233234

234235
- Process creation (processes are automatically provisioned when a package is published to `My Workspace`)
235236

236-
If you prefer to deploy the MCP Server in a different folder, additional steps will be required:
237+
If you prefer to deploy the MCP Server in a different folder, additional steps are required:
237238

238239
1. Create a process from the MCP Server package.
239240

@@ -242,7 +243,7 @@ If you prefer to deploy the MCP Server in a different folder, additional steps w
242243
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.
243244
///
244245

245-
To deploy your MCP server to UiPath Cloud Platform, follow these steps:
246+
To deploy your MCP server to UiPath Automation Cloud, follow these steps:
246247

247248
#### (Optional) Customize the Package
248249

@@ -265,7 +266,7 @@ Authors : John Doe
265266
✓ Project successfully packaged.
266267
```
267268

268-
#### Publish The Mcp Server Package
269+
#### Publish The MCP Server Package
269270

270271
<!-- termynal -->
271272
```shell
@@ -277,11 +278,11 @@ Authors : John Doe
277278
💡 Use the link above to configure any environment variables
278279
```
279280

280-
After publishing, you can configure and manage your MCP server through the UiPath Cloud interface:
281+
After publishing, you can configure and manage your MCP server through the UiPath Automation Cloud interface:
281282

282-
#### Configure in UiPath Cloud
283+
#### Configure in UiPath Automation Cloud
283284

284-
1. In `My Workspace`, navigate to the MCP Servers tab and click **Add MCP Server**
285+
1. In `My Workspace`, navigate to the **MCP Servers** tab and click **Add MCP Server**
285286

286287
<picture data-light="../quick_start_images/add-mcp-light.png" data-dark="../quick_start_images/add-mcp-dark.png">
287288
<source
@@ -308,13 +309,13 @@ After publishing, you can configure and manage your MCP server through the UiPat
308309
/>
309310
</picture>
310311

311-
Once deployed, the server will automatically start and register its available tools. You can monitor the job status in the MCP Server side panel.
312+
Once deployed, the server automatically starts and registers its available tools. You can monitor the job status in the MCP Server side panel.
312313

313314
## Connecting to the MCP Server
314315

315-
You can connect to your MCP server using any MCP client. Here's what you'll need:
316+
You can connect to your MCP server using any MCP client. Here's what you need:
316317

317-
1. **MCP Server URL**: Copy this from the UiPath MCP Servers page in Orchestrator
318+
1. **MCP Server URL**: Copy this from the UiPath **MCP Servers** page in Orchestrator
318319

319320
<picture data-light="../quick_start_images/copy-link-light.png" data-dark="../quick_start_images/copy-link-dark.png">
320321
<source
@@ -331,6 +332,6 @@ You can connect to your MCP server using any MCP client. Here's what you'll need
331332

332333
## Next Steps
333334

334-
Congratulations! You have successfully set up, created, published, and run a Coded UiPath MCP Server. 🚀
335+
Congratulations! You have successfully set up, created, published, and run a coded UiPath MCP Server. 🚀
335336

336337
For more coded MCP samples, please refer to our [samples section](https://github.com/UiPath/uipath-mcp-python/tree/main/samples) in GitHub.

0 commit comments

Comments
 (0)