|
| 1 | +--- |
| 2 | +title: "Hypermode Documentation MCP Server" |
| 3 | +description: |
| 4 | + "Learn how to use the Hypermode documentation MCP server to search |
| 5 | + documentation and get help with Dgraph DQL queries" |
| 6 | +sidebarTitle: "Docs MCP Server" |
| 7 | +--- |
| 8 | + |
| 9 | +The Hypermode docs MCP (Model Context Protocol) server provides AI assistants |
| 10 | +with direct access to search across the Hypermode documentation. This enables |
| 11 | +more accurate and contextual assistance when working with Hypermode features, |
| 12 | +Dgraph DQL queries, and development workflows. |
| 13 | + |
| 14 | +The MCP server is available as a remote MCP at `https://docs.hypermode.com/mcp`. |
| 15 | + |
| 16 | +## What's the Hypermode docs MCP server? |
| 17 | + |
| 18 | +The Hypermode docs MCP server is a specialized tool that allows AI assistants to |
| 19 | +search and retrieve information from the Hypermode documentation in real-time. |
| 20 | +It acts as a bridge between your AI assistant and the comprehensive Hypermode |
| 21 | +knowledge base, ensuring you get the most up-to-date and relevant information. |
| 22 | + |
| 23 | +## Available tools |
| 24 | + |
| 25 | +### Search |
| 26 | + |
| 27 | +Search across the Hypermode documentation to find relevant information, code |
| 28 | +examples, API references, and guides. |
| 29 | + |
| 30 | +**Parameters:** |
| 31 | + |
| 32 | +- `query` (string, required): The search query to execute across the |
| 33 | + documentation |
| 34 | + |
| 35 | +**Returns:** |
| 36 | + |
| 37 | +An array of search results, each containing: |
| 38 | + |
| 39 | +- `title` (string): The title of the documentation page |
| 40 | +- `content` (string): A brief description of the content |
| 41 | +- `url` (string): Direct link to the documentation page |
| 42 | +- `snippet` (string): Relevant text snippet from the documentation |
| 43 | + |
| 44 | +**Example tool call:** |
| 45 | + |
| 46 | +```json |
| 47 | +{ |
| 48 | + "name": "search", |
| 49 | + "arguments": { |
| 50 | + "query": "DQL query examples" |
| 51 | + } |
| 52 | +} |
| 53 | +``` |
| 54 | + |
| 55 | +**Example response:** |
| 56 | + |
| 57 | +```json |
| 58 | +{ |
| 59 | + "results": [ |
| 60 | + { |
| 61 | + "title": "DQL Query Examples", |
| 62 | + "content": "Learn how to write DQL queries with filtering and range operations...", |
| 63 | + "url": "https://docs.hypermode.com/dgraph/dql/query", |
| 64 | + "snippet": "Use the @filter directive with ge() and le() functions to find users within age ranges..." |
| 65 | + } |
| 66 | + ] |
| 67 | +} |
| 68 | +``` |
| 69 | + |
| 70 | +**Use this tool when you need to:** |
| 71 | + |
| 72 | +- Answer questions about Hypermode features |
| 73 | +- Find specific documentation or guides |
| 74 | +- Understand how features work |
| 75 | +- Locate implementation details |
| 76 | +- Get help with Dgraph DQL queries |
| 77 | + |
| 78 | +## Setup Instructions |
| 79 | + |
| 80 | +### Claude Desktop |
| 81 | + |
| 82 | +1. Open Claude Desktop |
| 83 | +2. Go to **Settings** → **MCP Servers** |
| 84 | +3. Click **Add Server** |
| 85 | +4. Enter the following details: |
| 86 | + - **Name**: `Hypermode docs` |
| 87 | + - **URL**: `https://docs.hypermode.com/mcp` |
| 88 | +5. Click **Save** |
| 89 | +6. Restart Claude Desktop |
| 90 | + |
| 91 | +### VS Code |
| 92 | + |
| 93 | +1. Install the **MCP Client** extension from the VS Code marketplace |
| 94 | +2. Open Command Palette (`Cmd/Ctrl + Shift + P`) |
| 95 | +3. Type "MCP: Add Server" and select it |
| 96 | +4. Enter the server details: |
| 97 | + - **Name**: `Hypermode docs` |
| 98 | + - **URL**: `https://docs.hypermode.com/mcp` |
| 99 | +5. The MCP server will be available in your AI assistant interactions |
| 100 | + |
| 101 | +### Cursor |
| 102 | + |
| 103 | +1. Open Cursor |
| 104 | +2. Navigate to **Settings** → **AI** → **MCP Servers** |
| 105 | +3. Click **Add Server** |
| 106 | +4. Configure the server: |
| 107 | + - **Name**: `Hypermode docs` |
| 108 | + - **Endpoint**: `https://docs.hypermode.com/mcp` |
| 109 | +5. Save and restart Cursor |
| 110 | + |
| 111 | +## Tool call examples |
| 112 | + |
| 113 | +Here are actual examples of what the Hypermode Docs MCP server tool calls and |
| 114 | +responses look like: |
| 115 | + |
| 116 | +### Example 1: Searching for Dgraph DQL Examples |
| 117 | + |
| 118 | +**User Query**: "How to write a DQL query to find all users with a specific age |
| 119 | +range?" |
| 120 | + |
| 121 | +**MCP Search** The assistant can search the Hypermode docs for DQL examples, |
| 122 | +finding relevant documentation about: |
| 123 | + |
| 124 | +- Basic DQL query syntax |
| 125 | +- Filtering and range queries |
| 126 | +- User data models |
| 127 | +- Specific examples from tutorials |
| 128 | + |
| 129 | +**Result** The assistant provides a contextual answer with: |
| 130 | + |
| 131 | +- Relevant DQL query examples |
| 132 | +- Links to specific documentation pages |
| 133 | +- Additional context about Dgraph query patterns |
| 134 | + |
| 135 | +**MCP Tool Call**: |
| 136 | + |
| 137 | +```json |
| 138 | +{ |
| 139 | + "name": "search", |
| 140 | + "arguments": { |
| 141 | + "query": "DQL query find users age range filtering" |
| 142 | + } |
| 143 | +} |
| 144 | +``` |
| 145 | + |
| 146 | +**MCP Response**: |
| 147 | + |
| 148 | +```json |
| 149 | +{ |
| 150 | + "results": [ |
| 151 | + { |
| 152 | + "title": "DQL Query Examples", |
| 153 | + "content": "Learn how to write DQL queries with filtering and range operations...", |
| 154 | + "url": "https://docs.hypermode.com/dgraph/dql/query", |
| 155 | + "snippet": "Use the @filter directive with ge() and le() functions to find users within age ranges..." |
| 156 | + }, |
| 157 | + { |
| 158 | + "title": "Basic DQL Operations", |
| 159 | + "content": "Master the fundamentals of DQL query syntax...", |
| 160 | + "url": "https://docs.hypermode.com/dgraph/dql/basic-operations", |
| 161 | + "snippet": "Filtering with @filter allows you to narrow down results based on specific conditions..." |
| 162 | + } |
| 163 | + ] |
| 164 | +} |
| 165 | +``` |
| 166 | + |
| 167 | +### Example 2: Finding Hypermode agent connection guides |
| 168 | + |
| 169 | +**User Query**: "How to connect an agent to Stripe?" |
| 170 | + |
| 171 | +**MCP Search** The assistant searches for Stripe connection documentation, |
| 172 | +finding: |
| 173 | + |
| 174 | +- Step-by-step connection guides |
| 175 | +- Required configuration details |
| 176 | +- Example agent configurations |
| 177 | +- Troubleshooting tips |
| 178 | + |
| 179 | +**Result** The assistant delivers comprehensive setup instructions with direct |
| 180 | +links to relevant documentation sections. |
| 181 | + |
| 182 | +**MCP Tool Call**: |
| 183 | + |
| 184 | +```json |
| 185 | +{ |
| 186 | + "name": "search", |
| 187 | + "arguments": { |
| 188 | + "query": "Stripe agent connection setup guide" |
| 189 | + } |
| 190 | +} |
| 191 | +``` |
| 192 | + |
| 193 | +**MCP Response**: |
| 194 | + |
| 195 | +```json |
| 196 | +{ |
| 197 | + "results": [ |
| 198 | + { |
| 199 | + "title": "Stripe Connection Guide", |
| 200 | + "content": "Step-by-step instructions for connecting your Hypermode agent to Stripe...", |
| 201 | + "url": "https://docs.hypermode.com/agents/connections/stripe", |
| 202 | + "snippet": "Add your Stripe API keys and configure webhook endpoints for your agent..." |
| 203 | + }, |
| 204 | + { |
| 205 | + "title": "Available Connections", |
| 206 | + "content": "Overview of all supported payment and commerce connections...", |
| 207 | + "url": "https://docs.hypermode.com/agents/available-connections", |
| 208 | + "snippet": "Stripe is fully supported with payment processing and customer management capabilities..." |
| 209 | + } |
| 210 | + ] |
| 211 | +} |
| 212 | +``` |
| 213 | + |
| 214 | +### Example 3: Python Dgraph connection syntax |
| 215 | + |
| 216 | +**User Query**: "What's the syntax to create a connection to Hypermode graphs |
| 217 | +using the dgraph:// connection string in Python?" |
| 218 | + |
| 219 | +**MCP Search** The assistant searches for Python Dgraph connection |
| 220 | +documentation, finding: |
| 221 | + |
| 222 | +- Python SDK examples and tutorials |
| 223 | +- Connection string syntax and format |
| 224 | +- Hypermode graph connection guides |
| 225 | +- Code samples for dgraph:// protocol |
| 226 | + |
| 227 | +**Result** The assistant provides Python code examples with connection syntax |
| 228 | +and links to relevant documentation. |
| 229 | + |
| 230 | +**MCP Tool Call**: |
| 231 | + |
| 232 | +```json |
| 233 | +{ |
| 234 | + "name": "search", |
| 235 | + "arguments": { |
| 236 | + "query": "Python dgraph connection string dgraph:// syntax" |
| 237 | + } |
| 238 | +} |
| 239 | +``` |
| 240 | + |
| 241 | +**MCP Response**: |
| 242 | + |
| 243 | +```json |
| 244 | +{ |
| 245 | + "results": [ |
| 246 | + { |
| 247 | + "title": "Python SDK Documentation", |
| 248 | + "content": "Learn how to connect to Dgraph from Python applications...", |
| 249 | + "url": "https://docs.hypermode.com/dgraph/sdks/python", |
| 250 | + "snippet": "Use the dgraph:// protocol to connect to Hypermode graphs with Python client libraries..." |
| 251 | + }, |
| 252 | + { |
| 253 | + "title": "Graph Connection Guide", |
| 254 | + "content": "Step-by-step instructions for connecting to Hypermode graphs...", |
| 255 | + "url": "https://docs.hypermode.com/graphs/connect", |
| 256 | + "snippet": "Python connection examples using dgraph:// connection strings for Hypermode graphs..." |
| 257 | + } |
| 258 | + ] |
| 259 | +} |
| 260 | +``` |
| 261 | + |
| 262 | +## Benefits of using the MCP server |
| 263 | + |
| 264 | +1. **Real-time Information**: Always access the latest documentation |
| 265 | +2. **Contextual Results**: Get relevant information based on your specific query |
| 266 | +3. **Direct Links**: Navigate directly to the source documentation |
| 267 | +4. **Comprehensive Coverage**: Search across all Hypermode resources |
| 268 | +5. **AI-Optimized**: Designed specifically for AI assistant interactions |
| 269 | + |
| 270 | +## Troubleshooting |
| 271 | + |
| 272 | +### Common Issues |
| 273 | + |
| 274 | +#### Server connection failed |
| 275 | + |
| 276 | +- Verify the URL: `https://docs.hypermode.com/mcp` |
| 277 | +- Check your internet connection |
| 278 | +- Ensure the MCP client supports HTTPS connections |
| 279 | + |
| 280 | +#### Search not working |
| 281 | + |
| 282 | +- Restart your MCP client app |
| 283 | +- Verify the server is properly configured |
| 284 | +- Check if the server requires authentication (currently none required) |
| 285 | + |
| 286 | +#### No results found |
| 287 | + |
| 288 | +- Try different search terms |
| 289 | +- Use more specific queries |
| 290 | +- Check if the documentation covers your topic |
| 291 | + |
| 292 | +### Getting help |
| 293 | + |
| 294 | +If you encounter issues with the MCP server: |
| 295 | + |
| 296 | +1. Verify your configuration matches the setup instructions |
| 297 | +2. Check the MCP client's error logs |
| 298 | +3. Ensure you're using a supported MCP client |
| 299 | +4. Contact Hypermode support if issues persist |
| 300 | + |
| 301 | +## Advanced usage |
| 302 | + |
| 303 | +### Optimizing searches |
| 304 | + |
| 305 | +- Use specific technical terms (for example, "DQL aggregation" instead of "how |
| 306 | + to count") |
| 307 | +- Include feature names (for example, "Hypermode agents" instead of "agents") |
| 308 | +- Reference specific error messages or code snippets |
| 309 | + |
| 310 | +### Integration with development workflow |
| 311 | + |
| 312 | +- Use the MCP server during code reviews |
| 313 | +- Get instant help with Dgraph queries |
| 314 | +- Find examples for specific use cases |
| 315 | +- Access troubleshooting guides in real-time |
| 316 | + |
| 317 | +The Hypermode Docs MCP server transforms your AI assistant into a knowledgeable |
| 318 | +Hypermode expert, providing instant access to comprehensive documentation and |
| 319 | +helping you build better applications with confidence. |
0 commit comments