-
Notifications
You must be signed in to change notification settings - Fork 3
docs: add mcp docs #974
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
docs: add mcp docs #974
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,65 @@ | ||
| --- | ||
| title: Model Context Protocol (MCP) | ||
| --- | ||
|
|
||
| Connect AI assistants to Bytebase using the Model Context Protocol. | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| - [Configure external URL](/get-started/self-host/external-url) if you haven't already. | ||
|
|
||
| - OAuth authentication is required on first connection. Ensure you have appropriate Bytebase permissions. | ||
|
|
||
| ## Setup | ||
|
|
||
| Navigate to **Integration** > **MCP** in your Bytebase console. Choose one of the following options: | ||
|
|
||
| ### Option 1: JSON Configuration | ||
|
|
||
| Add this JSON to your MCP client configuration file: | ||
|
|
||
| ```json | ||
| { | ||
| "mcpServers": { | ||
| "bytebase": { | ||
| "type": "http", | ||
| "url": "{https://your-bytebase-url.com}/mcp" | ||
| } | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| ### Option 2: CLI Commands | ||
|
|
||
| Alternatively, use the CLI command shown on the MCP integration page for your preferred tool (Claude Code, Codex, Copilot CLI, Gemini CLI, or VS Code). | ||
|
|
||
adela-bytebase marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| ## Authentication | ||
|
|
||
| To connect to Bytebase, you need to finish the authentication process via OAuth by logging into Bytebase and authorizing the AI to access your Bytebase account. | ||
|
|
||
|  | ||
|
|
||
| Your tool will be connected to Bytebase once you click the Allow button. | ||
|
|
||
| ## Usage | ||
|
|
||
| Once connected, try asking your AI assistant: | ||
|
|
||
| - "List all projects in my Bytebase instance" | ||
| - "Show me the schema for database X" | ||
| - "Generate a migration script to add a users table" | ||
adela-bytebase marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
|
|
||
| ## Important notes | ||
|
|
||
| <Warning> | ||
|
|
||
| Caution: Once connected, your AI assistant will inherit all your permissions in Bytebase, including making changes to database or updating settings (in the case of an admin). So be cautious when instructing AI assistant to apply any change via Bytebase. | ||
| </Warning> | ||
|
|
||
| <Warning> | ||
|
|
||
| Audit logging: any action taken by the AI assistant via MCP will be audit-logged in Bytebase under your account. | ||
|
|
||
| </Warning> | ||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.