Skip to content

Commit a2a8258

Browse files
authored
Update build with ai section (#961)
* update build with ai section * update to claude code
1 parent 212c97b commit a2a8258

4 files changed

Lines changed: 125 additions & 10 deletions

File tree

docs/docs.json

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@
4747
},
4848
{
4949
"group": "Build with AI",
50-
"pages": ["get-started/ai-prompting", "get-started/prompt-library"]
50+
"pages": ["get-started/docs-mcp", "get-started/docs-llms", "get-started/prompt-library"]
5151
}
5252
],
5353
"global": {
@@ -1508,6 +1508,10 @@
15081508
]
15091509
},
15101510
"redirects": [
1511+
{
1512+
"source": "/get-started/ai-prompting",
1513+
"destination": "/get-started/docs-mcp"
1514+
},
15111515
{
15121516
"source": "/base-chain/network-information/bridges-mainnet",
15131517
"destination": "/base-chain/network-information/bridges"

docs/get-started/ai-prompting.mdx

Lines changed: 0 additions & 9 deletions
This file was deleted.

docs/get-started/docs-llms.mdx

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
---
2+
title: Static Docs Files
3+
sidebarTitle: Static Docs Files
4+
description: Use llms.txt and llms-full.txt to give AI assistants access to Base documentation.
5+
---
6+
7+
## Documentation index
8+
9+
Fetch the complete documentation index at: [https://docs.base.org/llms.txt](https://docs.base.org/llms.txt)
10+
11+
Use this file to discover all available pages before exploring further.
12+
13+
## Full documentation file
14+
15+
If your AI tool doesn't support MCP yet, you can use a static documentation file instead. This gives your AI assistant the entire Base documentation as one text file.
16+
17+
<Warning>
18+
The static `llms-full.txt` file is a snapshot and may not include the latest updates. Use [MCP](/get-started/docs-mcp) when possible for always-current docs.
19+
</Warning>
20+
21+
### Setup with Cursor
22+
23+
[Cursor](https://cursor.com/) is an AI-powered code editor built as a fork of VS Code with features like AI code completion and natural language editing.
24+
25+
<Steps>
26+
<Step title="Open docs settings">
27+
Go to **Settings** > **Features** > **Docs**.
28+
</Step>
29+
30+
<Step title="Add Base docs">
31+
Click **Add new doc** and paste: `https://docs.base.org/llms-full.txt`
32+
</Step>
33+
34+
<Step title="Reference in chat">
35+
Use `@docs -> Base` in your AI chat to reference the documentation.
36+
</Step>
37+
</Steps>
38+
39+
### Setup with Claude Code
40+
41+
[Claude Code](https://docs.claude.com/en/docs/claude-code/overview) is an agentic coding tool that lives in your terminal and understands your codebase.
42+
43+
<Steps>
44+
<Step title="Download the docs file">
45+
Download the static documentation file from: [https://docs.base.org/llms-full.txt](https://docs.base.org/llms-full.txt)
46+
</Step>
47+
48+
<Step title="Add to your project">
49+
Save the file in your project directory or a known location on your system.
50+
</Step>
51+
52+
<Step title="Reference in chat">
53+
Use the `/read` command or drag and drop the file path to include the documentation in your conversation. Claude Code will then have access to the full Base documentation for that session.
54+
</Step>
55+
</Steps>

docs/get-started/docs-mcp.mdx

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
---
2+
title: MCP Server
3+
sidebarTitle: MCP Server
4+
description: Connect your AI coding assistant to Base documentation using Model Context Protocol for real-time access.
5+
---
6+
7+
[Model Context Protocol (MCP)](https://modelcontextprotocol.io/) is an open standard that lets AI assistants securely access external data sources. The Base MCP server connects your AI coding assistant directly to our documentation, giving it live access to search and retrieve the exact information you need in real time.
8+
9+
## Setup with Cursor
10+
11+
[Cursor](https://cursor.com/) is an AI-powered code editor built as a fork of VS Code with features like AI code completion and natural language editing.
12+
13+
<Steps>
14+
<Step title="Open MCP settings">
15+
In Cursor, open **Settings** and navigate to **Tools & MCP**, then click **Add MCP Server**.
16+
</Step>
17+
18+
<Step title="Add Base docs server">
19+
In the `mcp.json` configuration file, add:
20+
21+
```json mcp.json
22+
{
23+
"mcpServers": {
24+
"base-docs": {
25+
"url": "https://docs.base.org/mcp"
26+
}
27+
}
28+
}
29+
```
30+
</Step>
31+
32+
<Step title="Save and restart">
33+
Save the file and restart Cursor to apply the changes.
34+
</Step>
35+
36+
<Step title="Start building">
37+
Your AI assistant can now access Base docs in real time. Try asking: "How do I deploy a smart contract on Base?"
38+
</Step>
39+
</Steps>
40+
41+
## Setup with Claude Code
42+
43+
[Claude Code](https://docs.claude.com/en/docs/claude-code/overview) is an agentic coding tool that lives in your terminal and understands your codebase.
44+
45+
<Steps>
46+
<Step title="Add the Base docs MCP server">
47+
Run the following command in your terminal:
48+
49+
```bash Terminal
50+
claude mcp add --transport http base-docs https://docs.base.org/mcp
51+
```
52+
</Step>
53+
54+
<Step title="Verify installation">
55+
Check that the server was added successfully:
56+
57+
```bash Terminal
58+
claude mcp list
59+
```
60+
</Step>
61+
62+
<Step title="Start building">
63+
Launch Claude Code and start asking questions. Try: "How do I deploy a smart contract on Base?"
64+
</Step>
65+
</Steps>

0 commit comments

Comments
 (0)