Skip to content

Commit 1b2f21e

Browse files
update mcp docs
1 parent a2ae075 commit 1b2f21e

File tree

2 files changed

+48
-0
lines changed

2 files changed

+48
-0
lines changed

docs/docs.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -298,6 +298,12 @@
298298
"group": "Infrastructure as Code",
299299
"pages": ["integrations/terraform/overview"]
300300
},
301+
{
302+
"group": "AI Integration",
303+
"pages": [
304+
"integrations/mcp"
305+
]
306+
},
301307
{
302308
"group": "3rd Party",
303309
"pages": [

docs/integrations/mcp.mdx

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
title: Model Context Protocol (MCP)
3+
---
4+
5+
Connect AI assistants to Bytebase using the Model Context Protocol.
6+
7+
## Prerequisites
8+
9+
- [Configure external URL](/get-started/self-host/external-url) if you haven't already.
10+
11+
- OAuth authentication is required on first connection. Ensure you have appropriate Bytebase permissions.
12+
13+
## Setup
14+
15+
Navigate to **Integration** > **MCP** in your Bytebase console. Choose one of the following options:
16+
17+
### Option 1: JSON Configuration
18+
19+
Add this JSON to your MCP client configuration file:
20+
21+
```json
22+
{
23+
"mcpServers": {
24+
"bytebase": {
25+
"type": "http",
26+
"url": "{https://your-bytebase-url.com}/mcp"
27+
}
28+
}
29+
}
30+
```
31+
32+
### Option 2: CLI Commands
33+
34+
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).
35+
36+
## Usage
37+
38+
Once connected, try asking your AI assistant:
39+
40+
- "List all projects in my Bytebase instance"
41+
- "Show me the schema for database X"
42+
- "Generate a migration script to add a users table"

0 commit comments

Comments
 (0)