Skip to content

Use the guide in your AI assistant

Connect your AI assistant to the public Orbit guide to ask how Orbit works and get links to the relevant pages. This is available independently of your Orbit account. The connection is free of API keys and only reads public documentation.

  1. Ask the person hosting the guide connection for its installation-page address.
  2. Open that page in your browser. It offers English and German instructions and ready-made links for Cursor and VS Code. Click the link for your editor and confirm the installation there. Manual configuration is shown alongside it.
  3. For other assistants, follow the instructions below or copy the ready-made command from the installation page.
  4. Enable the connection in your assistant, then ask: “How do I enable dark mode in Orbit?” Ask it to search the Orbit guide and include source links.

In the examples, replace ORBIT_DOCS_MCP_URL with the installation-page address without a trailing slash. Keep /mcp at the end of the connection address.

Run this in your terminal:

Terminal window
claude mcp add --transport http orbit-docs 'ORBIT_DOCS_MCP_URL/mcp'

Use /mcp in Claude Code to check the connection.

Run this in your terminal:

Terminal window
codex mcp add orbit-docs --url 'ORBIT_DOCS_MCP_URL/mcp'

Run codex mcp list to check that it was added.

Open Settings → Connectors → Add custom connector, name it Orbit guide and enter ORBIT_DOCS_MCP_URL/mcp. This requires a plan that supports remote connectors.

If you use local configuration instead, the installation page provides an optional JSON example using the third-party mcp-remote bridge. It requires Node.js and downloads that bridge; review it before use. Prefer the native connector when available.

{
"mcpServers": {
"orbit-docs": {
"command": "npx",
"args": [
"--yes",
"--ignore-scripts",
"mcp-remote@0.15.2",
"ORBIT_DOCS_MCP_URL/mcp",
"--transport",
"http-only"
]
}
}
}

For an HTTP address on a trusted private network, add "--allow-http" after "http-only" in the example. Use HTTPS for public connections.

  1. If available for your account, open Settings → Apps → Advanced settings and enable Developer mode. Your workspace may require an administrator.
  2. Create a custom app, name it Orbit guide, enter ORBIT_DOCS_MCP_URL/mcp and select No authentication. In newer versions, use Plugins → Add custom MCP server for this step.
  3. Review the three read-only tools and confirm. Select the connection in a new chat.

ChatGPT needs a public HTTPS address for this setup. A localhost or private Tailscale address will not work. Ask the host whether ChatGPT can reach the service. Available menus and access depend on your plan, workspace policies and app version.

The assistant can search pages, read a full page and list available pages in English or German. Search uses words rather than meaning: try the wording used in the guide or explicitly ask for German or English results. The assistant may still make mistakes; follow the linked guide when an answer is unclear.

No. It only reads public guide pages. It cannot read your tasks, calendar, family information or account, and cannot make changes.

A search sends the search query and optionally the language and number of results. Reading a page sends its guide path; listing pages may send a language. The server also receives ordinary connection metadata, but does not store requests or queries. Do not include personal information in searches. Your assistant’s own privacy rules still apply to your conversation.

No. The documentation connection has neither. Your assistant may require its own subscription or permission to use custom connections.

The host may only allow access through its private network. Check the address and network access with the host. Reconnecting cannot make a private service public.

Version 0.1.0+production