diff --git a/docs/quick_start.md b/docs/quick_start.md index e04f979..ec06681 100644 --- a/docs/quick_start.md +++ b/docs/quick_start.md @@ -2,11 +2,11 @@ ## Introduction -This guide provides step-by-step instructions for setting up, creating, publishing, and running your first UiPath coded MCP Server. +This guide provides instructions for setting up and running a UiPath coded MCP Server. ## Prerequisites -Before proceeding, ensure you have the following prerequisites: +You need: - Python 3.11 or higher - `pip` or `uv` package manager @@ -15,7 +15,7 @@ Before proceeding, ensure you have the following prerequisites: ## Creating a New Project -We recommend using `uv` for package management. To create a new project: +Use `uv` for package management. To create a new project: //// tab | Linux, macOS, Windows Bash @@ -90,7 +90,7 @@ Activate with: source .venv/bin/activate ## Create Your First UiPath Coded MCP Server -Generate your first UiPath LangChain agent: +Create your first MCP server @@ -108,6 +108,10 @@ Start 'math-server' as a self-hosted MCP server πŸ’‘ 2. Start the server locally: uipath run math-server ``` +/// warning +_uipath new_ command deletes all previous `.py` files in the current directory. + /// + This command creates the following files: | File Name | Description | @@ -116,9 +120,6 @@ This command creates the following files: | `mcp.json` | Configuration file needed for coded UiPath MCP Servers. | | `pyproject.toml` | Project metadata and dependencies as per [PEP 518](https://peps.python.org/pep-0518/). | -/// warning -_uipath new_ command will delete all previous `.py` files in the current directory. - /// ## Initialize Project @@ -135,7 +136,7 @@ This command creates the following files: | File Name | Description | | ---------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| `.env` | Environment variables and secrets (this file will not be packed & published). | +| `.env` | Environment variables and secrets (this file is not packed & published). | | `uipath.json` | Input/output JSON schemas and bindings. | ## Authenticate With UiPath @@ -196,7 +197,7 @@ Registering server runtime ... #### Verifying the Server -Once started successfully, your MCP server will appear in Orchestrator. Navigate to the MCP Servers tab in your configured folder: +Once started successfully, your MCP server will appear in Orchestrator. Navigate to the **MCP Servers** tab in your configured folder: ```shell @@ -277,11 +278,11 @@ Authors : John Doe πŸ’‘ Use the link above to configure any environment variables ``` -After publishing, you can configure and manage your MCP server through the UiPath Cloud interface: +After publishing, you can configure and manage your MCP server through the UiPath Automation Cloud interface: -#### Configure in UiPath Cloud +#### Configure in UiPath Automation Cloud -1. In `My Workspace`, navigate to the MCP Servers tab and click **Add MCP Server** +1. In `My Workspace`, navigate to the **MCP Servers** tab and click **Add MCP Server** -Once deployed, the server will automatically start and register its available tools. You can monitor the job status in the MCP Server side panel. +Once deployed, the server automatically starts and registers its available tools. You can monitor the job status in the MCP Server side panel. ## Connecting to the MCP Server -You can connect to your MCP server using any MCP client. Here's what you'll need: +You can connect to your MCP server using any MCP client. Here's what you need: -1. **MCP Server URL**: Copy this from the UiPath MCP Servers page in Orchestrator +1. **MCP Server URL**: Copy this from the UiPath **MCP Servers** page in Orchestrator