AI
Connect an AI assistant
GitRead can be connected to AI assistants that support the Model Context Protocol (MCP), for example Claude. Once connected, you can ask the assistant things like "Write a getting started page for my project" or "Find all pages that mention the old pricing and update them".
AI assistant access is part of some plans only. If your plan does not include it, the connection screen tells you so. See Plans and limits.
Connect
- In your AI assistant, add a new MCP server or custom connector.
- Enter the address of the GitRead MCP server: your GitRead address followed by
/mcp, for examplehttps://your-gitread-address/mcp. - The assistant opens a GitRead page that asks you to sign in and approve the connection.
- Review what the assistant may do and click to approve.
The connection uses a secure sign-in (OAuth). You never have to copy a password or an API key.
What the assistant can do
| Tool | What it does |
|---|---|
| List projects | Shows your projects. |
| Get project | Shows the page tree of a project with groups and subpages. |
| Get page | Reads the title and Markdown content of a page. |
| Search pages | Finds pages by keyword. |
| Create page | Adds a new page, optionally in a group or below another page. |
| Update page | Changes the title and replaces the content of a page. |
| Create group | Adds a group to the navigation. |
Page content is exchanged as Markdown. See Markdown syntax for the supported extensions such as hints and buttons.
What the assistant cannot do
For your safety the connection is deliberately limited. An assistant cannot:
- delete pages, groups or projects
- change project settings, visibility or passwords
- access your account or other users' data
Tips
- Ask the assistant to read a page before changing it. Updating replaces the whole page content.
- Review changes in the editor afterwards. The assistant works on your live pages, and the editor autosaves, so check the result in the Preview tab.
- If you edit a page in the editor while the assistant works on it, reload the page in the editor to see the assistant's changes.
Disconnect
Remove the GitRead connector in your AI assistant's settings. The assistant loses access immediately.
Limits
Requests from a connected assistant are rate limited. If the assistant reports that it is sending too many requests, wait a moment and try again. Accounts that are blocked cannot use the connection.