Skip to content

Commit e8e718e

Browse files
committed
Refine Admin MCP documentation for clarity and completeness
- Remove commented-out key features section for a cleaner presentation - Update installation instructions for various tools with specific transport config details - Enhance troubleshooting section with common issues and solutions - Add new installation guidance for Qodo Gen and clarify manual configuration steps - Streamline security and limitations section for better readability
1 parent b0830ae commit e8e718e

1 file changed

Lines changed: 50 additions & 82 deletions

File tree

pages/docs/admin-mcp.mdx

Lines changed: 50 additions & 82 deletions
Original file line numberDiff line numberDiff line change
@@ -13,18 +13,6 @@ including uploading logos for both light and dark themes.
1313
This MCP server is currently in BETA. Help us improve the server by filing [issues or making suggestions](https://github.com/hellocoop/MCP/issues).
1414
</Callout>
1515

16-
{/*
17-
## Key Features
18-
19-
- One powerful tool (`hello_manage_app`) for all app management actions
20-
- Supports `create`, `update`, `read`, `create_secret`, and logo uploads
21-
- Compatible with major AI clients: Cursor, Claude, VS Code, LM Studio, and more
22-
- Automatically includes full developer context (user, teams, applications)
23-
- Secure OAuth 2.1 flow with short-lived access tokens
24-
- Supports both HTTP (remote) and STDIO (local) configurations
25-
- Access resources such as the Logo Design Guide, Login Button Guide, Quickstart Setup, and full API documentation
26-
*/}
27-
2816
## Installing
2917

3018
### Cursor
@@ -65,10 +53,14 @@ claude mcp add hello-admin http https://mcp.hello.coop/
6553
See [Claude guide](https://docs.anthropic.com/en/docs/claude-code/mcp) for more information.
6654

6755
### Claude Desktop
68-
???
56+
**Manual Install**:
57+
Navigate to Connector Settings → Add a Custom Connector → Paste the [HTTP Transport config](#manual).
58+
See [Claude Desktop Guide](https://modelcontextprotocol.io/docs/tutorials/use-remote-mcp-server) for more information.
6959

7060
### Gemini CLI
71-
???
61+
**Manual Install**:
62+
Create `.gemini/settings.json` in your project's root directory → Add `mcpServers` block → Paste the [HTTP Transport config](#manual).
63+
See [Gemini CLI Guide](https://github.com/google-gemini/gemini-cli/blob/main/docs/tools/mcp-server.md#configure-the-mcp-server-in-settingsjson) for more information.
7264

7365
### Goose
7466
<span className="mt-4 block"/>
@@ -77,8 +69,8 @@ See [Claude guide](https://docs.anthropic.com/en/docs/claude-code/mcp) for more
7769
</a>
7870

7971
**Manual Install**:
80-
Advanced settings → Extensions → Add custom extension and paste the [HTTP config](@ROHAN).
81-
See [Goose guide](@ROHAN) for more information.
72+
Advanced settings → Extensions → Add custom extension and paste the [HTTP Transport config](#manual).
73+
See [Example guide](https://docs.pieces.app/products/mcp/goose) for more information.
8274

8375
### LM Studio
8476
<span className="mt-4 block"/>
@@ -87,31 +79,37 @@ See [Goose guide](@ROHAN) for more information.
8779
</a>
8880

8981
**Manual Install**:
90-
Program → Install → Edit mcp.json and paste the [HTTP config](@ROHAN).
91-
See [LM Studio](@ROHAN) for more information.
82+
Program → Install → Edit mcp.json and paste the [HTTP Transport config](#manual).
83+
See [LM Studio](https://lmstudio.ai/blog/lmstudio-v0.3.17#add-mcp-servers-to-lm-studio) for more information.
84+
85+
### Qodo Gen
9286

93-
-----------
87+
**Manual Install**:
88+
Open the chat panel → Connect more tools → Add new MCP → Paste the [Stdio Transport config](#manual) config.
89+
See [Qodo Gen](https://docs.qodo.ai/qodo-documentation/qodo-gen/qodo-gen-chat/agentic-mode/agentic-tools-mcps#id-1.-local-mcps) for more information.
90+
91+
---
9492

95-
You can install the Hellō MCP server manually using a simple configuration object, or use one of the quick-install options available in select tools.
93+
Don’t see your tool listed? [File an issue](https://github.com/hellocoop/hello.dev/issues) and we’ll add support.
9694

97-
### Manual Configuration (Works in Most Tools)
98-
> Using a supported tool like Cursor or VS Code? You can skip ahead to the Quick Installation Options below.
95+
---
9996

100-
Use the following configurations if you're setting up the MCP server manually or using a tool that prompts for input.
97+
### Manual
10198

102-
**HTTP Transport (Remote – Recommended)**
99+
**From Source**:
100+
Clone the repo and follow the instructions at [hellocoop/MCP](https://github.com/hellocoop/MCP#local-development).
103101

102+
**HTTP Transport (Remote - Recommended)**:
104103
```json
105104
{
106105
"hello-admin-http": {
107106
"url": "https://mcp.hello.coop/",
108107
"type": "http"
109108
}
110109
}
111-
````
112-
113-
**NPM Package (Local)**
110+
```
114111

112+
**NPM Package (Local - Most compatible)**:
115113
```json
116114
{
117115
"hello-admin-stdio": {
@@ -122,48 +120,10 @@ Use the following configurations if you're setting up the MCP server manually or
122120
}
123121
```
124122

125-
### Quick Installation Options
126-
Some tools support direct install links or commands that preconfigure the MCP server for you.
127-
128-
129-
<details>
130-
<summary>LM Studio</summary>
131-
132-
<div className="px-2 py-4">
133-
Click to install:
134123

135-
<a href="https://lmstudio.ai/install-mcp?name=hello-admin&config=eyJ1cmwiOiJodHRwczovL21jcC5oZWxsby5jb29wIn0K">
136-
<img src="https://files.lmstudio.ai/deeplink/mcp-install-light.svg" alt="Add MCP Server hello-admin to LM Studio" />
137-
</a>
138-
139-
Or go to `Program → Install → Edit mcp.json` and paste the standard config.
140-
141-
</div>
142-
</details>
143-
144-
<details>
145-
<summary>Qodo Gen</summary>
146-
147-
<p className="px-2 py-4">In Qodo Gen: open the chat panel → Connect more tools → Add new MCP → Paste the HTTP Transport config.</p>
148-
149-
</details>
150-
151-
<details>
152-
<summary>Windsurf</summary>
153-
<p className="px-2 py-4">Follow the [Windsurf MCP documentation](https://docs.windsurf.com/windsurf/cascade/mcp). Use the standard config.</p>
154-
</details>
155-
156-
<details>
157-
<summary>Run from Source</summary>
158-
<p className="px-2 py-4">Clone the repo and follow the instructions at: https://github.com/hellocoop/MCP#local-development</p>
159-
</details>
160-
161-
Don’t see your tool listed? [File an issue](https://github.com/hellocoop/hello.dev/issues) and we’ll add support.
124+
## Features
162125

163-
## Available Commands
164-
KEY FEATURES
165-
166-
### `hello_manage_app` (Core Tool)
126+
### `hello_manage_app`
167127

168128
This is the primary tool for managing Hellō applications.
169129

@@ -183,7 +143,7 @@ Each response includes:
183143
* All apps associated with your teams
184144
* Current team and app state
185145

186-
## Authentication
146+
### Authentication
187147

188148
This MCP server uses OAuth 2.1 for secure authentication:
189149

@@ -192,12 +152,32 @@ This MCP server uses OAuth 2.1 for secure authentication:
192152
3. **Token**: The server receives a 1-hour access token
193153
4. **Context**: All API calls return your complete developer context
194154

195-
## Troubleshooting
155+
### Security & Limitations
196156

197-
PRE REQUSITIES
157+
**Security:**
158+
- OAuth 2.1 industry-standard authentication
159+
- Short-lived tokens (1-hour expiration)
160+
- HTTPS-only API communication
161+
- Access scoped to create, read, update. Deletion actions are intentionally restricted.
162+
163+
**Current Limitations:**
164+
- Cannot delete applications (use [Hellō Console](https://console.hello.coop) for deletion)
165+
- Token requires re-authentication after 1 hour of inactivity
166+
167+
## Troubleshooting
198168

199169
### Common Issues
200170

171+
**"npx command not found" error:**
172+
- Install Node.js 18+ from [nodejs.org](https://nodejs.org/)
173+
- Verify installation: `node --version` and `npm --version`
174+
- On macOS/Linux, you may need to restart your terminal after installation
175+
176+
**"MCP server not found" error:**
177+
- Ensure your MCP client supports the transport type (HTTP or stdio)
178+
- Check that the server URL or command is correctly configured
179+
- Verify network connectivity for HTTP transport
180+
201181
**"Authentication required" errors:**
202182
- The server will automatically prompt for login when needed
203183
- Make sure you complete the browser-based OAuth flow
@@ -220,18 +200,6 @@ PRE REQUSITIES
220200
- **Contribute**: [Submit Pull Requests](https://github.com/hellocoop/MCP/pulls)
221201
- **Community**: [Join our Slack Community](https://hello-community.slack.com/join/shared_invite/zt-1eccnd2np-qJoOWBkHGnpxvBpCTtaH9g#/shared-invite/email)
222202

223-
## Security & Limitations
224-
225-
**Security:**
226-
- OAuth 2.1 industry-standard authentication
227-
- Short-lived tokens (1-hour expiration)
228-
- HTTPS-only API communication
229-
- Access scoped to create, read, update. Deletion actions are intentionally restricted.
230-
231-
**Current Limitations:**
232-
- Cannot delete applications (use [Hellō Console](https://console.hello.coop) for deletion)
233-
- Token requires re-authentication after 1 hour of inactivity
234-
235203
---
236204

237205
For local development, testing, and advanced usage, visit the full [MCP Server GitHub repo](https://github.com/hellocoop/MCP).

0 commit comments

Comments
 (0)