Skip to content

Commit eba647a

Browse files
authored
Eric's Documentation Accuracy Review (#553)
* Update quickstart guides * Update 'Create MCP server' and 'create auth tool' * Self review * Update 'tool with secrets' page * Update Tools and Context * Remove logging mcp tool activity * Update url * Update organize MCP server tools * Update deploy docs * Update evals * Update cli page * Address nit * Address Mateos's comment & apply in multiple places
1 parent 3b50219 commit eba647a

File tree

16 files changed

+617
-786
lines changed

16 files changed

+617
-786
lines changed

app/en/home/api-keys/page.mdx

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -61,13 +61,17 @@ Visit the [API Keys page](https://api.arcade.dev/dashboard/api-keys) in Arcade D
6161
<Tabs.Tab>
6262

6363
```bash
64-
uv pip install arcade-ai
64+
uv tool install arcade-mcp
6565
```
6666

67+
<Callout type="info">
68+
This will install the Arcade CLI as a [uv tool](https://docs.astral.sh/uv/guides/tools/#installing-tools), making it available system wide.
69+
</Callout>
70+
6771
</Tabs.Tab>
6872
<Tabs.Tab>
6973
```bash
70-
pip install arcade-ai
74+
pip install arcade-mcp
7175
```
7276
</Tabs.Tab>
7377
</Tabs>

app/en/home/arcade-cli/page.mdx

Lines changed: 18 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -3,50 +3,36 @@ title: "Arcade CLI"
33
description: "Learn how to install and use the Arcade CLI"
44
---
55

6-
import { Tabs } from "nextra/components";
6+
import { Tabs, Callout } from "nextra/components";
77

88
# The Arcade CLI
99

10-
The Arcade CLI is a command-line tool that allows you to manage your Arcade deployments, generate, test, and manage your toolkits, and more.
10+
The Arcade CLI is a command-line tool that allows you to manage your Arcade deployments, generate, test, and manage your MCP servers, and more.
1111

12-
This same package contains the SDK that you will use to [build your own toolkits](/home/build-tools/create-a-mcp-server).
12+
## Install the Arcade CLI
1313

14-
## Installation
14+
In your terminal, run the following command to install the `arcade-mcp` package - Arcade's CLI:
1515

16-
Like all python packages, the Arcade CLI needs to be installed within the python virtual environment you are using for your Arcade development environment.
17-
18-
<Tabs items={["Python + uv", "Python + Conda", "Standard Python"]}>
19-
<Tabs.Tab>
20-
```bash
21-
# install uv: https://docs.astral.sh/uv/getting-started/installation/
16+
<Tabs items={["uv", "pip"]}>
17+
<Tabs.Tab>
2218

23-
uv venv --seed
24-
source .venv/bin/activate
19+
```bash
20+
uv tool install arcade-mcp
21+
```
2522

26-
````
27-
</Tabs.Tab>
28-
<Tabs.Tab>
29-
```bash
30-
# install miniconda: https://www.anaconda.com/docs/getting-started/miniconda/install
23+
<Callout type="info">
24+
This will install the Arcade CLI as a [uv tool](https://docs.astral.sh/uv/guides/tools/#installing-tools), making it available system wide.
25+
</Callout>
3126

32-
conda create --name arcade
33-
conda activate arcade
34-
````
27+
</Tabs.Tab>
3528

36-
</Tabs.Tab>
37-
<Tabs.Tab>
38-
```bash
39-
python -m venv .venv
40-
source .venv/bin/activate
41-
```
42-
</Tabs.Tab>
43-
</Tabs>
29+
<Tabs.Tab>
4430

45-
Now that your python virtual environment is activated, you can install the Arcade CLI with the following command:
31+
```bash
32+
pip install arcade-mcp
33+
```
4634

47-
<Tabs items={["uv", "pip"]}>
48-
<Tabs.Tab>```bash uv pip install arcade-mcp ```</Tabs.Tab>
49-
<Tabs.Tab>```bash pip install arcade-mcp ```</Tabs.Tab>
35+
</Tabs.Tab>
5036
</Tabs>
5137

5238
## Usage

app/en/home/build-tools/_meta.tsx

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
export default {
22
"create-a-mcp-server": "Create an MCP Server",
3-
"tool-context": "Tools and Context",
43
"create-a-tool-with-auth": "Create a tool with auth",
54
"create-a-tool-with-secrets": "Create a tool with secrets",
6-
"logging-mcp-tool-activity": "Logging tool activity",
5+
"tool-context": "Tools and Context",
76
"organize-mcp-server-tools": "Organize MCP server tools",
87
"providing-useful-tool-errors": "Providing useful tool errors",
98
"retry-tools-with-improved-prompt": "Retry tools with improved prompt",

app/en/home/build-tools/call-tools-from-mcp-clients/page.mdx

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -84,18 +84,20 @@ You can customize a lot of the configuration passing options to `arcade configur
8484
</Tabs.Tab>
8585
<Tabs.Tab>
8686

87-
Claude Desktop does not currently support the http transport.
87+
<Callout type="warning">
88+
Claude Desktop does not currently support the HTTP transport via JSON configuration files.
89+
</Callout>
8890

8991
</Tabs.Tab>
9092
</Tabs>
9193

9294
### stdio specific configuration
9395

94-
If you are using the stdio transport, `arcade configure` will assume the entrypoint (the script that contains the `MCPApp` instance and calls `app.run()`) to your MCP server is `server.py` and will set the working directory to the path of your entrypoint file. You can override this with the `--entrypoint` (or `-e`) option:
96+
If you are using the stdio transport, `arcade configure` will assume the entrypoint file (the script that contains the `MCPApp` instance and calls `app.run()`) to your MCP server is `server.py` and will set the working directory to the path of your entrypoint file. You can override this with the `--entrypoint` (or `-e`) option:
9597

9698
<Callout type="info">
97-
Note that the `--entrypoint` determines only the filename of the entrypoint
98-
script, not the path to the script.
99+
Note that the `--entrypoint` accepts only the filename of the entrypoint
100+
file, not the path to the script.
99101
</Callout>
100102
<Callout type="info">
101103
When using the stdio transport, `arcade configure` will automatically load the
@@ -130,7 +132,7 @@ If you are using the stdio transport, `arcade configure` will assume the entrypo
130132
</Tabs.Tab>
131133
</Tabs>
132134

133-
### http specific configuration
135+
### HTTP specific configuration
134136

135137
If you are using the streamable HTTP transport, `arcade configure` will assume the MCP server is running on the default port `8000` and that the MCP server is running locally (in localhost). You can override this with the `--host` (or `-h`) and `--port` (or `-p`) options:
136138

@@ -170,7 +172,9 @@ If you are using the streamable HTTP transport, `arcade configure` will assume t
170172
</Tabs.Tab>
171173
<Tabs.Tab>
172174

173-
Claude Desktop does not currently support the http transport via JSON configuration files.
175+
<Callout type="warning">
176+
Claude Desktop does not currently support the HTTP transport via JSON configuration files.
177+
</Callout>
174178

175179
</Tabs.Tab>
176180
</Tabs>
@@ -246,7 +250,7 @@ Each MCP client has a different way of configuring MCP servers. This section cov
246250
>
247251
<Tabs.Tab>
248252

249-
When configuring your MCP client using the stdio transport, you need to ensure that the MCP server is called using the right version of python and within the correct working directory. For example, let's pretend this is your setup:
253+
When configuring your MCP client using the stdio transport, you need to ensure that the MCP server is called using the right version of Python and within the correct working directory. For example, let's pretend this is your setup:
250254

251255
- Your virtual environment is located at `/path/to/your/project/.venv`
252256
- Your project is located at `/path/to/your/project`
@@ -270,7 +274,7 @@ Then, your MCP client's configuration file should look like this:
270274
}
271275
```
272276

273-
This will ensure that the command used by the MCP client to start the MCP server is the correct version of python and that the environment variables are set correctly.
277+
This will ensure that the command used by the MCP client to start the MCP server is the correct version of Python and that the environment variables are set correctly.
274278

275279
</Tabs.Tab>
276280
<Tabs.Tab>

0 commit comments

Comments
 (0)