Skip to content

Commit 02b47a5

Browse files
authored
Merge pull request #660 from bnb-chain/645-create-docsite-for-ask-ai-into-ide
645 create docsite for ask ai into ide
2 parents f8038bb + c802442 commit 02b47a5

12 files changed

+212
-0
lines changed
59.8 KB
Loading
49.4 KB
Loading

docs/showcase/img/3-start-mcp.png

12.8 KB
Loading
29.6 KB
Loading
75.1 KB
Loading
17.1 KB
Loading

docs/showcase/img/7-query-chat.png

85 KB
Loading
115 KB
Loading
97.6 KB
Loading

docs/showcase/mcp/ask-ai-to-ide.md

Lines changed: 105 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
1+
---
2+
title: Integrate BNBChain Ask AI into your IDE
3+
---
4+
5+
# Quick‑Start Tutorial
6+
7+
Follow these steps to wire any IDE that supports the **Model Context Protocol (MCP)** to BNB Chain’s Ask AI knowledge base **and start querying documentation right away**.
8+
9+
> **Time required:** ≈ 2 minutes
10+
> **Prerequisites:**
11+
> • IDE with an MCP client (e.g. VS Code MCP extension, Cursor ≥ 0.23.0, JetBrains plugin)
12+
13+
---
14+
15+
## 1 Add the Ask AI MCP server
16+
17+
1. Open your IDE’s **Settings / Preferences** and find the **MCP** section.
18+
2. Choose **Add MCP server** (wording may vary).
19+
3. Paste the JSON block below and save.
20+
21+
```jsonc
22+
{
23+
"mcpServers": {
24+
"bnbchain-askai-mcp": {
25+
"url": "https://mcp.inkeep.com/bnbchainorg/mcp",
26+
"id": "cm9qsf01p00bss6016ry68oil"
27+
}
28+
}
29+
}
30+
```
31+
32+
4. Reload the IDE window if the MCP client does not restart automatically.
33+
34+
A **Connected** status should now appear next to *bnbchain‑askai‑mcp*.
35+
36+
---
37+
38+
## 2 What the MCP can do
39+
40+
The Ask AI MCP lets you **query** BNB Chain’s public documentation corpus in natural language and receive the most relevant passages, with source links, inside your editor.
41+
It is *read‑only* – no blockchain transactions are executed.
42+
43+
---
44+
45+
## 3 Run queries inside your IDE
46+
47+
Below are three common ways to interact with the Ask AI MCP once it is connected.
48+
49+
### 3.1 Chat Panels (Copilot, Cursor Chat, etc.)
50+
51+
1. Open your IDE’s AI/Chat pane (Copilot Chat, Cursor side‑chat, JetBrains AI Assistant…).
52+
2. Locate the **agent / provider selector** at the top of the chat window.
53+
3. Choose **bnbchain‑askai‑mcp**.
54+
4. Ask questions in plain English – e.g. *“Summarise BEP‑20.”*
55+
56+
> **Want a detailed step-by-step walkthrough for VS Code?** Check out the companion guide: [Ask AI in VS Code](ask-ai-vs-code-guide.md) – complete with annotated screenshots.
57+
58+
### 3.2 Command Palette / Command Menu
59+
60+
| IDE | How to open | Steps |
61+
| ------------- | ----------------------------------------------------------- | ------------------------------------------------------------------------------ |
62+
| **VS Code** | <kbd>Ctrl/Cmd + Shift + P</kbd> | Type **“MCP: Run Query”** → pick **bnbchain‑askai‑mcp** → enter your question. |
63+
| **Cursor** | <kbd>Cmd + K</kbd> (mac) or <kbd>Ctrl + K</kbd> (win/linux) | Select **Ask MCP…** → choose **bnbchain‑askai‑mcp** → ask away. |
64+
| **JetBrains** | <kbd>Shift + Shift</kbd> then “MCP Query” | Pick **bnbchain‑askai‑mcp** and type a question. |
65+
66+
### 3.3 Terminal / cURL (optional)
67+
68+
For quick tests outside the IDE you can hit the endpoint directly:
69+
70+
```bash
71+
curl -s -X POST \
72+
-H "Content-Type: application/json" \
73+
-d '{"query":"What is BEP‑20?"}' \
74+
https://mcp.inkeep.com/bnbchainorg/mcp
75+
```
76+
77+
You’ll receive a JSON response containing an `answer` field and `sources` array.
78+
79+
---
80+
81+
## 4 Example queries
82+
83+
```text
84+
What is the gas limit on BSC blocks?
85+
86+
Summarise BEP‑336 in two sentences.
87+
88+
List all fee tiers supported by opBNB.
89+
90+
Explain the purpose of Greenfield buckets.
91+
```
92+
93+
---
94+
95+
## 5 Troubleshooting
96+
97+
| Symptom | Fix |
98+
| -------------------------- | ---------------------------------------------------------------- |
99+
| **400/401 response codes** | Verify the JSON snippet (no trailing commas). |
100+
| **Long latency (> 10 s)** | Disable any *Throttle Streaming* or similar setting in your IDE. |
101+
| **No answer returned** | Make sure you chose **bnbchain‑askai‑mcp** and asked a question. |
102+
103+
Need more help? Ping us in **#ai‑tooling** on the BNB Chain Discord.
104+
105+
Open an issue in the [docs repo](https://github.com/bnb-chain/docs-site/issues) if your favourite editor is missing.

0 commit comments

Comments
 (0)