Skip to content

Commit 15f872a

Browse files
committed
added customer facing mcp and updated cli
1 parent 7d151ee commit 15f872a

File tree

3 files changed

+43
-4
lines changed

3 files changed

+43
-4
lines changed

advanced/mcp/cli.mdx

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,14 @@
11
---
2-
title: "Installing the MCP Server"
3-
description: "Learn how to install the Mintlify's MCP Server"
2+
title: "The Mintlify MCP Server"
3+
description: "Learn how to install and use the Mintlify's MCP Server"
44
---
55
<Tip>
6-
To get started with the MCP server make sure you have an API key. If you don't have one, navigate to `Settings > API Keys > Chat API Key` and create a new key.
6+
This page is dedicated to the Mintlify MCP Server. If you are looking for information on generating your MCP, please refer to the [MCP Generator](/advanced/mcp/overview) page.
77
</Tip>
88

9+
## Get started
10+
To use the Mintlify MCP server you will need an [API key](https://mintlify.com/docs/advanced/rest-api/overview#authentication) from your Mintlify account. If you don't have one, navigate to `Settings > API Keys > Chat API Key` and create a new key.
11+
912
## Start the MCP server locally
1013
<Steps>
1114
<Step title="Install the server through the CLI">

advanced/mcp/customer-mcp.mdx

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
---
2+
title: "Running your MCP Server"
3+
description: "Learn how to set up your own MCP Server"
4+
---
5+
<Tip>
6+
This page is dedicated to setting up your own MCP Server. If you are looking for information on using the Mintlify MCP Server, please refer to the [Installing and using the Mintlify MCP Server](/advanced/mcp/cli) page.
7+
</Tip>
8+
9+
## Get started
10+
Run `npm i mcp` to install the `mcp` CLI.
11+
12+
In the [dashboard](https://dashboard.mintlify.com/products/mcp) go to `MCP Server` to see your unique installation command. This is the command to install your MCP Server with the `mcp` CLI.
13+
14+
## Start the MCP server locally
15+
<Steps>
16+
<Step title="Install the server through the CLI">
17+
Run the following command to install the server:
18+
```bash
19+
npx mcp add [your subdomain]
20+
```
21+
</Step>
22+
<Step title="Add the authentication token if applicable">
23+
If your API requires an authentication token, tell your end-customer to get it and apply it when given this response:
24+
```
25+
> What is the Authorization (basic token)?
26+
```
27+
Otherwise, you can skip this step.
28+
29+
</Step>
30+
<Step title="Start your MCP server">
31+
You can now run:
32+
```bash
33+
npm --prefix ~/.mcp/[your subdomain] start
34+
```
35+
</Step>
36+
</Steps>

docs.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,7 @@
141141
{
142142
"group": "Model Context Protocol",
143143
"icon": "server",
144-
"pages": ["advanced/mcp/overview", "advanced/mcp/cli"]
144+
"pages": ["advanced/mcp/overview", "advanced/mcp/cli", "advanced/mcp/customer-mcp"]
145145
},
146146
{
147147
"group": "REST API",

0 commit comments

Comments
 (0)