Skip to content

Commit ee22ac6

Browse files
committed
add amp docs
1 parent ece6782 commit ee22ac6

3 files changed

Lines changed: 48 additions & 17 deletions

File tree

docs.json

Lines changed: 5 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,6 @@
2222
"icon": "pen-to-square"
2323
}
2424
]
25-
2625
},
2726
"groups": [
2827
{
@@ -36,11 +35,7 @@
3635
},
3736
{
3837
"group": "MCP Server",
39-
"pages": [
40-
"mcp/tools",
41-
"mcp/prompts",
42-
"mcp/registry"
43-
]
38+
"pages": ["mcp/tools", "mcp/prompts", "mcp/registry"]
4439
},
4540
{
4641
"group": "Resources",
@@ -64,6 +59,7 @@
6459
"install/augment",
6560
"install/goose",
6661
"install/droid-cli",
62+
"install/amp",
6763
"install/opencode",
6864
"install/cline",
6965
"install/roo-code",
@@ -92,9 +88,7 @@
9288
},
9389
{
9490
"group": "Comparison",
95-
"pages": [
96-
"comparison/context7"
97-
]
91+
"pages": ["comparison/context7"]
9892
},
9993
{
10094
"group": "Support",
@@ -109,9 +103,7 @@
109103
},
110104
{
111105
"group": "Changelog",
112-
"pages": [
113-
"changelog"
114-
]
106+
"pages": ["changelog"]
115107
}
116108
]
117109
},
@@ -133,10 +125,7 @@
133125
}
134126
},
135127
"contextual": {
136-
"options": [
137-
"copy",
138-
"view"
139-
]
128+
"options": ["copy", "view"]
140129
},
141130
"footer": {
142131
"socials": {

install/amp.mdx

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
title: "Amp"
3+
description: "Connect Amp to up-to-date and token-efficient documentation."
4+
---
5+
6+
import GetHelp from "/snippets/get-help.mdx";
7+
8+
How to set up Ref with [Amp CLI](https://ampcode.com/manual#mcp).
9+
10+
## Install
11+
12+
Run the `claude` install command. You can copy a version of the command with your API key pre-populated at [ref.tools/install](https://ref.tools/install)
13+
14+
```
15+
amp mcp add Ref https://api.ref.tools/mcp --header "x-ref-api-key: <YOUR_API_KEY>"
16+
```
17+
18+
You can find your API key at [ref.tools/keys](https://ref.tools/keys)
19+
20+
## Verify
21+
22+
Run the command:
23+
24+
```
25+
claude mcp doctor
26+
```
27+
28+
You should see:
29+
30+
```
31+
➜ amp mcp doctor
32+
User settings: <filepath>
33+
Workspace settings: <filepath>
34+
35+
Ref (user settings): connected (2 tools: ref_search_documentation, ref_read_url)
36+
```
37+
38+
<GetHelp />

install/index.mdx

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ You can find your API key at [ref.tools/keys](https://ref.tools/keys)
2424
If you use OAuth in combination with [Teams](/usage/teams), you may need to specify the team you want Ref to access. Ref will do it's best to intelligently pick the correct team but you may want to manually force a specific team.
2525

2626
Here is the algorithm Ref uses to pick the user or team scope:
27+
2728
```
2829
For base OAuth url https://api.ref.tools/mcp if the user belongs to:
2930
- no teams -> user scope
@@ -79,6 +80,10 @@ Choose your coding environment below to get started:
7980
<Card title="Goose" icon="dove" href="/install/goose">
8081
Connect Goose to up-to-date and token-efficient documentation.
8182
</Card>
83+
84+
<Card title="Amp" icon="arrow-up" href="/install/amp">
85+
Connect Amp to up-to-date and token-efficient documentation.
86+
</Card>
8287

8388
<Card title="Augment" icon="wand-magic-sparkles" href="/install/augment">
8489
Connect Augment to up-to-date and token-efficient documentation.
@@ -108,4 +113,3 @@ Choose your coding environment below to get started:
108113
Connect Gemini CLI to up-to-date and token-efficient documentation.
109114
</Card>
110115
</CardGroup>
111-

0 commit comments

Comments
 (0)