diff --git a/pages/docs/_meta.json b/pages/docs/_meta.json index d796bf0..3b1cfd0 100644 --- a/pages/docs/_meta.json +++ b/pages/docs/_meta.json @@ -8,7 +8,7 @@ "apis": "API References", "oidc": "OpenID Connect", "mockin": "Hellō Mockin", - "mcp": "Hellō MCP Server", + "admin-mcp": "Admin MCP Server", "comparison": "Hellō vs ___", "roadmap": "Roadmap" } \ No newline at end of file diff --git a/pages/docs/admin-mcp.mdx b/pages/docs/admin-mcp.mdx new file mode 100644 index 0000000..3d27f08 --- /dev/null +++ b/pages/docs/admin-mcp.mdx @@ -0,0 +1,205 @@ +import { Callout } from 'nextra/components' + +# Admin MCP Server (BETA) + +
+ BETA +
+ +The Admin MCP server lets you create and manage your Hellō applications directly from your AI assistant, +including uploading logos for both light and dark themes. + + +This MCP server is currently in BETA. Help us improve the server by filing [issues or making suggestions](https://github.com/hellocoop/MCP/issues). + + +## Installing + +### Cursor + + + + Install MCP Server + + +**Manual Install**: +Cursor Settings → MCP → Add new MCP Server. Use type `http` and URL `https://admin-mcp.hello.coop/`. +See [Cursor guide](https://docs.cursor.com/context/mcp#installing-mcp-servers) for more information. + +### VSCode + + + + Install on VS Code + + +**Manual Install**: + +```bash +code --add-mcp '{"name":"Hellō Admin","url":"https://admin-mcp.hello.coop","type":"http"}' +``` + +See [VS Code guide](https://code.visualstudio.com/docs/copilot/chat/mcp-servers#_add-an-mcp-server) for more information. + + +### Claude Code + +Using the Claude CLI: + +```bash +claude mcp add hello-admin http https://admin-mcp.hello.coop/ +``` + +See [Claude guide](https://docs.anthropic.com/en/docs/claude-code/mcp) for more information. + +### Claude Desktop +**Manual Install**: +Navigate to Connector Settings → Add a Custom Connector → Paste the [HTTP Transport config](#manual). +See [Claude Desktop Guide](https://modelcontextprotocol.io/docs/tutorials/use-remote-mcp-server) for more information. + +### Gemini CLI +**Manual Install**: +Create `.gemini/settings.json` in your project's root directory → Add `mcpServers` block → Paste the [HTTP Transport config](#manual). +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. + +### Goose + + + Install in Goose + + +**Manual Install**: +Advanced settings → Extensions → Add custom extension and paste the [HTTP Transport config](#manual). +See [Example guide](https://docs.pieces.app/products/mcp/goose) for more information. + +### LM Studio + + + Add MCP Server hello-admin to LM Studio + + +**Manual Install**: +Program → Install → Edit mcp.json and paste the [HTTP Transport config](#manual). +See [LM Studio](https://lmstudio.ai/blog/lmstudio-v0.3.17#add-mcp-servers-to-lm-studio) for more information. + +### Qodo Gen + +**Manual Install**: +Open the chat panel → Connect more tools → Add new MCP → Paste the [Stdio Transport config](#manual) config. +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. + +--- + +Don’t see your tool listed? [File an issue](https://github.com/hellocoop/hello.dev/issues) and we’ll add support. + +--- + +### Manual + +**From Source**: +Clone the repo and follow the instructions at [hellocoop/MCP](https://github.com/hellocoop/MCP#local-development). + +**HTTP Transport (Remote - Recommended)**: +```json +{ + "hello-admin-http": { + "url": "https://admin-mcp.hello.coop/", + "type": "http" + } +} +``` + +**NPM Package (Local - Most compatible)**: +```json +{ + "hello-admin-stdio": { + "command": "npx", + "args": ["-y", "@hellocoop/admin-mcp@latest"], + "type": "stdio" + } +} +``` + + +## Features + +### `hello_manage_app` + +This is the primary tool for managing Hellō applications. + +Supported actions: + +* `create` – Create new applications with smart defaults +* `read` – Retrieve application or profile details +* `update` – Update app settings (redirect URIs, names, etc.) +* `create_secret` – Generate OAuth client secrets +* `update_logo_from_data` – Upload a logo using base64 data +* `update_logo_from_url` – Upload a logo via public URL + +Each response includes: + +* Your user profile (name, email, picture) +* Your teams and organizations, along with assigned roles +* All apps associated with your teams +* Current team and app state + +### Authentication + +This MCP server uses OAuth 2.1 for secure authentication: + +1. **OAuth Flow**: When you first use the tool, the server opens your browser +2. **Login**: Complete the login process with your Hellō account +3. **Token**: The server receives a 1-hour access token +4. **Context**: All API calls return your complete developer context + +### Security & Limitations + +**Security:** +- OAuth 2.1 industry-standard authentication +- Short-lived tokens (1-hour expiration) +- HTTPS-only API communication +- Access scoped to create, read, update. Deletion actions are intentionally restricted. + +**Current Limitations:** +- Cannot delete applications (use [Hellō Console](https://console.hello.coop) for deletion) +- Token requires re-authentication after 1 hour of inactivity + +## Troubleshooting + +### Common Issues + +**"npx command not found" error:** +- Install Node.js 18+ from [nodejs.org](https://nodejs.org/) +- Verify installation: `node --version` and `npm --version` +- On macOS/Linux, you may need to restart your terminal after installation + +**"MCP server not found" error:** +- Ensure your MCP client supports the transport type (HTTP or stdio) +- Check that the server URL or command is correctly configured +- Verify network connectivity for HTTP transport + +**"Authentication required" errors:** +- The server will automatically prompt for login when needed +- Make sure you complete the browser-based OAuth flow + +**"Application not found" errors:** +- Use `hello_manage_app` with `action: "read"` to see your applications +- Make sure you're using the correct `client_id` + +**Logo upload issues:** +- Ensure `logo_content_type` matches your image format +- Supported formats: PNG, JPEG, GIF, WebP, APNG, SVG +- Keep file sizes under 100KB for best performance + +### Getting Help & Contributing + +**We want your feedback!** This MCP server is in beta and we're actively improving it. + +- **Documentation**: [MCP Server Repository](https://github.com/hellocoop/MCP) +- **Report Issues**: [GitHub Issues](https://github.com/hellocoop/MCP/issues) +- **Contribute**: [Submit Pull Requests](https://github.com/hellocoop/MCP/pulls) +- **Community**: [Join our Slack Community](https://hello-community.slack.com/join/shared_invite/zt-1eccnd2np-qJoOWBkHGnpxvBpCTtaH9g#/shared-invite/email) + +--- + +For local development, testing, and advanced usage, visit the full [MCP Server GitHub repo](https://github.com/hellocoop/MCP). diff --git a/pages/docs/mcp.mdx b/pages/docs/mcp.mdx deleted file mode 100644 index 8281958..0000000 --- a/pages/docs/mcp.mdx +++ /dev/null @@ -1,179 +0,0 @@ -import { Callout } from 'nextra/components' - -# MCP Server (BETA) - -BETA - -Model Context Protocol (MCP) server for creating and managing Hellō applications directly from your AI assistant. - - -**BETA Status**: This MCP server is currently in beta. We're actively seeking feedback and welcome contributions! Please report issues, suggest improvements, or submit pull requests to help us improve the developer experience. - - -## Overview - -The Hellō MCP server provides a **single powerful tool** (`hello_manage_app`) that lets you create and manage your Hellō applications directly from your AI assistant, including uploading logos for both light and dark themes. - -## Installation - -| Cursor | VS Code | -|--------|---------| -| [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.coop%22%2C%22type%22%3A%22http%22%7D) | - -### Configuration Options - -**HTTP Transport (Remote - Recommended):** -```json -{ - "hello-admin-http": { - "url": "https://mcp.hello.coop/", - "type": "http" - } -} -``` - -**NPM Package (Local):** -```json -{ - "hello-admin-stdio": { - "command": "npx", - "args": ["-y", "@hellocoop/mcp@latest"], - "type": "stdio" - } -} -``` - -📖 **[Local Development Setup](https://github.com/hellocoop/MCP#local-development)** - For running from source - -## Available Tools - -### Core Tool: `hello_manage_app` - -**The main tool for all application management** with these actions: - -- **`create`** - Create new applications with smart defaults -- **`read`** - Read application details (or profile-only without client_id) -- **`update`** - Update application settings -- **`create_secret`** - Generate OAuth client secrets -- **`upload_logo_file`** - Upload logo from base64 data -- **`upload_logo_url`** - Upload logo from URL - -**Every response includes your complete profile context:** -- Your user profile (name, email, picture) -- All your teams/organizations with roles -- All your applications with team associations -- Current team and application state - -{/* -## Usage Examples - -### Creating Your First Application - -1. **Check your profile context**: - ``` - Use hello_manage_app with action: "read" (no client_id) - ``` - -2. **Create an application**: - ``` - Use hello_manage_app with: - - action: "create" - - name: "My App" - - dev_redirect_uris: ["http://localhost:3000/callback"] - ``` - -3. **Upload a logo**: - ``` - Use hello_manage_app with: - - action: "upload_logo_url" - - client_id: "your-app-id" - - logo_url: "https://example.com/logo.png" - - logo_content_type: "image/png" - ``` - -### Managing Applications - -**Read specific application:** -``` -Use hello_manage_app with: -- action: "read" -- client_id: "your-app-id" -``` - -**Update application:** -``` -Use hello_manage_app with: -- action: "update" -- client_id: "your-app-id" -- name: "Updated App Name" -- tos_uri: "https://example.com/terms" -``` - -**Create client secret:** -``` -Use hello_manage_app with: -- action: "create_secret" -- client_id: "your-app-id" -``` -*/} - -## Authentication - -The MCP server uses OAuth 2.1 for secure authentication: - -1. **OAuth Flow**: When you first use the tool, the server opens your browser -2. **Login**: Complete the login process with your Hellō account -3. **Token**: The server receives a 1-hour access token -4. **Context**: All API calls return your complete developer context - - -## Available Resources - -Access comprehensive documentation and guidance: - -- **Hellō Documentation** - Complete integration documentation -- **Hellō Quickstarts** - Framework-specific setup guides -- **Hellō Logo Design Guidance** - Guide for creating theme-appropriate logos -- **Hellō Login Button Implementation** - Complete button implementation guide - -## Troubleshooting - -### Common Issues - -**"Authentication required" errors:** -- The server will automatically prompt for login when needed -- Make sure you complete the browser-based OAuth flow - -**"Application not found" errors:** -- Use `hello_manage_app` with `action: "read"` to see your applications -- Make sure you're using the correct `client_id` - -**Logo upload issues:** -- Ensure `logo_content_type` matches your image format -- Supported formats: PNG, JPEG, GIF, WebP, APNG, SVG -- Keep file sizes under 100KB for best performance - -### Getting Help & Contributing - -**We want your feedback!** This MCP server is in beta and we're actively improving it. - -- **Documentation**: [MCP Server Repository](https://github.com/hellocoop/MCP) -- **Report Issues**: [GitHub Issues](https://github.com/hellocoop/MCP/issues) -- **Contribute**: [Submit Pull Requests](https://github.com/hellocoop/MCP/pulls) -- **Community**: [Join our Slack Community](https://hello-community.slack.com/join/shared_invite/zt-1eccnd2np-qJoOWBkHGnpxvBpCTtaH9g#/shared-invite/email) - -## Security & Limitations - -**Security:** -- OAuth 2.1 industry-standard authentication -- Short-lived tokens (1-hour expiration) -- HTTPS-only API communication -- Access scoped to create, read, update. No deletion permitted. - -**Current Limitations:** -- Cannot delete applications (use [Hellō Console](https://console.hello.coop) for deletion) -- Token requires re-authentication after 1 hour of inactivity - ---- - -For detailed development setup, testing, and contribution guidelines, visit the [Hellō MCP Server repository](https://github.com/hellocoop/MCP). diff --git a/styles/index.css b/styles/index.css index b55c2e4..c09420e 100644 --- a/styles/index.css +++ b/styles/index.css @@ -50,12 +50,12 @@ main a[target="_blank"]:after { .beta-label { position: absolute; - top: 54px; + top: 12px; right: 32px; - width: 80px; + width: 60px; } -@media screen and (min-width: 768px) { +@media screen and (min-width: 900px) { .beta-label { position: absolute; top: 32px;