Skip to content

Commit fd95b05

Browse files
committed
docs: Comment out MCP documentation - under development
- Hide all MCP server installation and usage documentation - Keep BETA label and page structure - Show 'Under Development' message until server is ready for public use
1 parent 76a8802 commit fd95b05

File tree

1 file changed

+51
-41
lines changed

1 file changed

+51
-41
lines changed

pages/docs/mcp.mdx

Lines changed: 51 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@ import { Callout } from 'nextra/components'
44

55
<img src="https://cdn.hello.coop/images/beta-label.png" alt="BETA" className="beta-label"/>
66

7+
## Under Development
8+
9+
{/*
710
Model Context Protocol (MCP) server for creating and managing Hellō applications directly from your AI assistant.
811
912
<Callout type="warning">
@@ -12,74 +15,80 @@ Model Context Protocol (MCP) server for creating and managing Hellō application
1215
1316
## Overview
1417
15-
The Hellō MCP server provides programmatic access to the Hellō Admin API, allowing you to create and manage your Hellō applications without switching to the [Hellō Console](https://console.hello-beta.net)(NOTE: this is a link to the BETA console). This streamlines your development workflow by integrating application management directly into your AI assistant.
18+
The Hellō Admin MCP server provides programmatic access to the Hellō Admin API, allowing you to create and manage your Hellō applications without switching to the [Hellō Console](https://console.hello.coop), streamlining your development workflow by integrating application management directly into your AI assistant.
1619
17-
**Note:** This server can only perform creation and management operations. To delete applications, you'll need to visit the [Hellō Console](https://console.hello.coop).
20+
**Note:** The MCP Server can only perform creation and management operations. To delete applications, you'll need to visit the [Hellō Console](https://console.hello.coop).
1821
19-
## Installation
22+
## Authorization
2023
21-
### VS Code One-Click Install
24+
MCP Clients gain access to the APIs by requesting the `mcp` scope. The resulting access token is only valid for an hour, and no refresh token is provided. If the access token has expired, then a new authorization flow will be initiated.
2225
23-
If you're using VS Code with MCP support, these links will install the server directly:
26+
For clients using the `stdio` transport, the authorization flow is started by the local MCP server. For clients using the new `streamableHTTP` transport, the client will detect authorization is required and will start the authorization flow.
2427
25-
**Stdio Transport (Local):**
26-
<a href="vscode:mcp/install?%7B%22name%22%3A%22Hell%C5%8D%20Admin%20%28BETA%29%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40hellocoop%2Fmcp%40latest%22%5D%2C%22type%22%3A%22stdio%22%2C%22env%22%3A%7B%22HELLO_DOMAIN%22%3A%22hello-beta.net%22%7D%7D">
27-
<img src="https://img.shields.io/badge/Install%20Stdio-VS%20Code-blue?style=for-the-badge&logo=visualstudiocode" alt="Install MCP using stdio in VS Code" />
28-
</a>
28+
## Installation
2929
30-
### Cursor One-Click Install
30+
| Cursor | VS Code |
31+
|--------|---------|
32+
| [Install MCP Server](https://cursor.com/install-mcp?name=hello-admin&config=eyJ1cmwiOiJodHRwczovL21jcC5oZWxsby5jb29wIn0K) | [Install on VS Code](vscode:mcp/install?%7B%22name%22%3A%22Hell%C5%8D%20Admin%22%2C%22url%22%3A%22https%3A//mcp.hello-beta.net%22%2C%22type%22%3A%22http%22%7D) |
3133
32-
If you're using Cursor, click this link to automatically install the Hellō MCP server:
34+
### VS Code Configuration
3335
34-
<a href="@cursor://anysphere.cursor-deeplink/mcp/install?name=hello&config=eyJ1cmwiOiJodHRwczovL21jcC5oZWxsby5jb29wIn0K">
35-
<img src="https://img.shields.io/badge/Install%20in%20Cursor-000000?style=for-the-badge&logo=cursor" alt="Install MCP in Cursor" />
36-
</a>
36+
Add to your `.vscode/mcp.json` file in your workspace or global settings:
3737
38-
Or copy and paste this deeplink directly into Cursor:
38+
**HTTP Transport (Remote):**
39+
```json
40+
{
41+
"servers": {
42+
"hello-admin": {
43+
"type": "http",
44+
"url": "https://mcp.hello.coop"
45+
}
46+
}
47+
}
3948
```
40-
@cursor://anysphere.cursor-deeplink/mcp/install?name=hello&config=eyJ1cmwiOiJodHRwczovL21jcC5oZWxsby5jb29wIn0K
49+
50+
**Stdio Transport (Local):**
51+
```json
52+
{
53+
"servers": {
54+
"hello-admin": {
55+
"type": "stdio",
56+
"command": "npx",
57+
"args": ["-y", "@hellocoop/mcp@latest"]
58+
}
59+
}
60+
}
4161
```
4262
43-
### Manual Configuration
63+
### Other MCP Clients
4464
45-
If the one-click install doesn't work, add one of these configurations to your MCP client settings:
65+
For other MCP clients, use these configurations:
66+
67+
**Stdio Transport (Local):**
4668
47-
#### Stdio Transport (Local)
4869
```json
4970
{
50-
"hello-admin-stdio": {
51-
"command": "npx",
52-
"args": ["-y", "@hellocoop/mcp@latest"],
53-
"type": "stdio",
54-
"env": {
55-
"HELLO_DOMAIN": "hello-beta.net"
71+
"mcpServers": {
72+
"hello-admin": {
73+
"command": "npx",
74+
"args": ["-y", "@hellocoop/mcp@latest"]
5675
}
5776
}
5877
}
5978
```
6079
61-
The stdio transport:
62-
- Runs a local server process
63-
- Performs OAuth authentication in your browser
64-
- Gets a 1-hour access token for Admin API calls
65-
- Best for development and testing
66-
67-
#### streamableHTTP Transport (Remote)
80+
**HTTP Transport (Remote):**
6881
```json
6982
{
70-
"hello-admin-http": {
71-
"url": "https://mcp.hello-beta.net/",
72-
"type": "http"
83+
"mcpServers": {
84+
"hello-admin": {
85+
"url": "https://mcp.hello.coop",
86+
"type": "http"
87+
}
7388
}
7489
}
7590
```
7691
77-
The HTTP transport:
78-
- Connects to our hosted MCP server
79-
- Handles OAuth authentication remotely
80-
- No local processes required
81-
- Best for production use
82-
8392
## Available Tools
8493
8594
The MCP server provides these tools for managing your Hellō applications:
@@ -261,3 +270,4 @@ npm run get-token # Get access token for API testing
261270
---
262271
263272
For more information, visit the [Hellō MCP Server repository](https://github.com/hellocoop/mcp).
273+
*/}

0 commit comments

Comments
 (0)