Add Windows support to user quickstart, move user quickstart to end, remove open source quick start.
This commit is contained in:
Drew Bent
parent
75bfa63aa0
commit
0f0bcfdb51
4 changed files with 67 additions and 48 deletions
|
|
@ -46,13 +46,6 @@ Choose the path that best fits your needs:
|
|||
|
||||
#### Quick Starts
|
||||
<CardGroup cols={2}>
|
||||
<Card
|
||||
title="For Claude Users"
|
||||
icon="bolt"
|
||||
href="/quickstart/user"
|
||||
>
|
||||
Get started using pre-built servers in Claude for Desktop to experience the power of MCP
|
||||
</Card>
|
||||
<Card
|
||||
title="For Server Developers"
|
||||
icon="bolt"
|
||||
|
|
@ -68,11 +61,11 @@ Choose the path that best fits your needs:
|
|||
Get started building your own client that can integrate with all MCP servers
|
||||
</Card>
|
||||
<Card
|
||||
title="For Open Source Developers"
|
||||
title="For Claude Desktop Users"
|
||||
icon="bolt"
|
||||
href="/quickstart/opensource"
|
||||
href="/quickstart/user"
|
||||
>
|
||||
Dig into the MCP spec and contribute to the ongoing development of MCP
|
||||
Get started using pre-built servers in Claude for Desktop
|
||||
</Card>
|
||||
</CardGroup>
|
||||
|
||||
|
|
|
|||
|
|
@ -50,10 +50,9 @@
|
|||
{
|
||||
"group": "Quickstart",
|
||||
"pages": [
|
||||
"quickstart/user",
|
||||
"quickstart/server",
|
||||
"quickstart/client",
|
||||
"quickstart/opensource"
|
||||
"quickstart/user"
|
||||
]
|
||||
},
|
||||
"examples",
|
||||
|
|
|
|||
|
|
@ -1,22 +0,0 @@
|
|||
---
|
||||
title: "For Open Source Developers"
|
||||
description: "Dig into the MCP spec and contribute to the ongoing development of MCP."
|
||||
---
|
||||
|
||||
## 1. Review the MCP architecture
|
||||
|
||||
<Card title="Core architecture" icon="sitemap" href="/concepts/architecture" horizontal>
|
||||
Understand how MCP connects clients, servers, and LLMs.
|
||||
</Card>
|
||||
|
||||
## 2. Read the MCP specification
|
||||
|
||||
<Card title="Specification" icon="book" href="https://spec.modelcontextprotocol.io" horizontal>
|
||||
This specification defines the authoritative protocol requirements
|
||||
</Card>
|
||||
|
||||
## 3. Find a place to contribute
|
||||
|
||||
<Card title="Contributing" icon="code" href="https://github.com/modelcontextprotocol/.github/blob/main/profile/CONTRIBUTING.md" horizontal>
|
||||
We are committed to building MCP as a collaborative, open-source project and ecosystem.
|
||||
</Card>
|
||||
|
|
@ -1,9 +1,9 @@
|
|||
---
|
||||
title: "For Claude Users"
|
||||
description: "Get started using pre-built servers in Claude for Desktop to experience the power of MCP."
|
||||
title: "For Claude Desktop Users"
|
||||
description: "Get started using pre-built servers in Claude for Desktop."
|
||||
---
|
||||
|
||||
In this tutorial, you will extend Claude for Desktop so that it can read from your computer's file system, write new files, move files, and even search files.
|
||||
In this tutorial, you will extend [Claude for Desktop](https://claude.ai/download) so that it can read from your computer's file system, write new files, move files, and even search files.
|
||||
|
||||
<Frame>
|
||||
<img src="/images/quickstart-filesystem.png" />
|
||||
|
|
@ -39,9 +39,15 @@ Click on "Developer" in the lefthand bar of the Settings pane, and then click on
|
|||
<img src="/images/quickstart-developer.png" />
|
||||
</Frame>
|
||||
|
||||
This will create a configuration file at `~/Library/Application Support/Claude/claude_desktop_config.json` if you don't already have one, and will display the file in your file system.
|
||||
This will create a configuration file at:
|
||||
- macOS: `~/Library/Application Support/Claude/claude_desktop_config.json`
|
||||
- Windows: `%APPDATA%\Claude\claude_desktop_config.json`
|
||||
|
||||
Open up the configuration file in any text editor (e.g. [VS Code](https://code.visualstudio.com/)). Replace the file contents with this:
|
||||
if you don't already have one, and will display the file in your file system.
|
||||
|
||||
Open up the configuration file in any text editor. Replace the file contents with this:
|
||||
<Tabs>
|
||||
<Tab title="MacOS/Linux">
|
||||
```json
|
||||
{
|
||||
"mcpServers": {
|
||||
|
|
@ -57,17 +63,40 @@ Open up the configuration file in any text editor (e.g. [VS Code](https://code.v
|
|||
}
|
||||
}
|
||||
```
|
||||
</Tab>
|
||||
<Tab title="Windows">
|
||||
```json
|
||||
{
|
||||
"mcpServers": {
|
||||
"filesystem": {
|
||||
"command": "npx",
|
||||
"args": [
|
||||
"-y",
|
||||
"@modelcontextprotocol/server-filesystem",
|
||||
"C:\\Users\\username\\Desktop",
|
||||
"C:\\Users\\username\\Downloads"
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
</Tab>
|
||||
</Tabs>
|
||||
|
||||
Make sure to replace `username` with your computer's username. The paths should point to valid directories that you want Claude to be able to access and modify. It's set up to work for Desktop and Downloads, but you can add more paths as well.
|
||||
|
||||
You will also need Node.js on your computer for this to run properly. In the command line of your computer, verify you have Node installed:
|
||||
You will also need [Node.js](https://nodejs.org) on your computer for this to run properly. To verify you have Node installed, open the command line on your computer.
|
||||
- On macOS, open the Terminal from your Applications folder
|
||||
- On Windows, press Windows + R, type "cmd", and press Enter
|
||||
|
||||
Once in the command line, verify you have Node installed by entering in the following command:
|
||||
```bash
|
||||
node --version
|
||||
```
|
||||
If needed, download Node from [nodejs.org](https://nodejs.org/).
|
||||
If you get an error saying "command not found" or "node is not recognized", download Node from [nodejs.org](https://nodejs.org/).
|
||||
|
||||
<Tip>
|
||||
**How does this work?**
|
||||
**How does the configuration file work?**
|
||||
|
||||
This configuration file tells Claude for Dekstop which MCP servers to start up every time you start the application. In this case, we have added one server called "filesystem" that will use the Node `npx` command to install and run `@modelcontextprotocol/server-filesystem`. This server, described [here](https://github.com/modelcontextprotocol/servers/tree/main/src/filesystem), will let you access your file system in Claude for Desktop.
|
||||
</Tip>
|
||||
|
|
@ -113,21 +142,41 @@ As needed, Claude will call the relevant tools and seek your approval before tak
|
|||
3. Make sure the file paths included in `claude_desktop_config.json` are valid and that they are absolute and not relative
|
||||
4. Look at [logs](#getting-logs-from-claude-for-desktop) to see why the server is not connecting
|
||||
5. In your command line, try manually running the server (replacing `username` as you did in `claude_desktop_config.json`) to see if you get any errors:
|
||||
<Tabs>
|
||||
<Tab title="MacOS/Linux">
|
||||
```bash
|
||||
npx -y @modelcontextprotocol/server-filesystem /Users/username/Desktop /Users/username/Downloads`
|
||||
```
|
||||
</Tab>
|
||||
<Tab title="Windows">
|
||||
```bash
|
||||
npx -y @modelcontextprotocol/server-filesystem C:\Users\username\Desktop C:\Users\username\Downloads
|
||||
```
|
||||
</Tab>
|
||||
</Tabs>
|
||||
</Accordion>
|
||||
<Accordion title="Getting logs from Claude for Desktop">
|
||||
Claude.app logging related to MCP is written to log files in `~/Library/Logs/Claude`:
|
||||
Claude.app logging related to MCP is written to log files in:
|
||||
- macOS: `~/Library/Logs/Claude`
|
||||
- Windows: `%APPDATA%\Claude\logs`
|
||||
|
||||
- `mcp.log` will contain general logging about MCP connections and connection failures.
|
||||
- Files named `mcp-server-SERVERNAME.log` will contain error (stderr) logging from the named server.
|
||||
|
||||
You can run the following command to list recent logs and follow along with any new ones:
|
||||
```bash
|
||||
# Check Claude's logs for errors
|
||||
tail -n 20 -f ~/Library/Logs/Claude/mcp*.log
|
||||
```
|
||||
You can run the following command to list recent logs and follow along with any new ones (on Windows, it will only show recent logs):
|
||||
<Tabs>
|
||||
<Tab title="MacOS/Linux">
|
||||
```bash
|
||||
# Check Claude's logs for errors
|
||||
tail -n 20 -f ~/Library/Logs/Claude/mcp*.log
|
||||
```
|
||||
</Tab>
|
||||
<Tab title="Windows">
|
||||
```bash
|
||||
type "%APPDATA%\Claude\logs\mcp*.log"
|
||||
```
|
||||
</Tab>
|
||||
</Tabs>
|
||||
</Accordion>
|
||||
<Accordion title="Tool calls failing silently">
|
||||
If Claude attempts to use the tools but they fail:
|
||||
|
|
|
|||
Loading…
Reference in a new issue