Skip to content

Context7 Platform -- Up-to-date docs for AI agents

chore: format

enesgules53fa8c3e9634
diff --git a/.github/workflows/ecr-deploy.yml b/.github/workflows/ecr-deploy.yml
index 7916db24..6f0796e1 100644
--- a/.github/workflows/ecr-deploy.yml
+++ b/.github/workflows/ecr-deploy.yml
@@ -1,51 +1,51 @@
name: Deploy to AWS ECR
on:
- workflow_dispatch:
- inputs:
- version:
- description: 'Docker image version tag (e.g., v0.0.22)'
- required: true
- type: string
+ workflow_dispatch:
+ inputs:
+ version:
+ description: "Docker image version tag (e.g., v0.0.22)"
+ required: true
+ type: string
jobs:
- build-and-push:
- runs-on: ubuntu-latest
-
- steps:
- - name: Checkout code
- uses: actions/checkout@v4
-
- - name: Configure AWS credentials
- uses: aws-actions/configure-aws-credentials@v4
- with:
- aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
- aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
- aws-region: ${{ secrets.AWS_REGION }}
-
- - name: Login to Amazon ECR
- id: login-ecr
- uses: aws-actions/amazon-ecr-login@v2
-
- - name: Set up Docker Buildx
- uses: docker/setup-buildx-action@v3
-
- - name: Build and push Docker image
- id: build-push
- uses: docker/build-push-action@v5
- with:
- context: .
- platforms: linux/amd64
- push: true
- tags: |
- ${{ secrets.ECR_REGISTRY }}/${{ secrets.ECR_REPOSITORY }}:${{ inputs.version }}
- cache-from: type=gha
- cache-to: type=gha,mode=max
-
- - name: Create GitHub Summary
- run: |
- echo "## Docker Image Deployed Successfully" >> $GITHUB_STEP_SUMMARY
- echo "" >> $GITHUB_STEP_SUMMARY
- echo "**Image Tag:** \`${{ inputs.version }}\`" >> $GITHUB_STEP_SUMMARY
- echo "" >> $GITHUB_STEP_SUMMARY
- echo "**Status:** ✅ Image pushed to AWS ECR" >> $GITHUB_STEP_SUMMARY
+ build-and-push:
+ runs-on: ubuntu-latest
+
+ steps:
+ - name: Checkout code
+ uses: actions/checkout@v4
+
+ - name: Configure AWS credentials
+ uses: aws-actions/configure-aws-credentials@v4
+ with:
+ aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
+ aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
+ aws-region: ${{ secrets.AWS_REGION }}
+
+ - name: Login to Amazon ECR
+ id: login-ecr
+ uses: aws-actions/amazon-ecr-login@v2
+
+ - name: Set up Docker Buildx
+ uses: docker/setup-buildx-action@v3
+
+ - name: Build and push Docker image
+ id: build-push
+ uses: docker/build-push-action@v5
+ with:
+ context: .
+ platforms: linux/amd64
+ push: true
+ tags: |
+ ${{ secrets.ECR_REGISTRY }}/${{ secrets.ECR_REPOSITORY }}:${{ inputs.version }}
+ cache-from: type=gha
+ cache-to: type=gha,mode=max
+
+ - name: Create GitHub Summary
+ run: |
+ echo "## Docker Image Deployed Successfully" >> $GITHUB_STEP_SUMMARY
+ echo "" >> $GITHUB_STEP_SUMMARY
+ echo "**Image Tag:** \`${{ inputs.version }}\`" >> $GITHUB_STEP_SUMMARY
+ echo "" >> $GITHUB_STEP_SUMMARY
+ echo "**Status:** ✅ Image pushed to AWS ECR" >> $GITHUB_STEP_SUMMARY
diff --git a/README.md b/README.md
index d69b3bc0..e76825b7 100644
--- a/README.md
+++ b/README.md
@@ -169,41 +169,6 @@ amp mcp add context7 --header "CONTEXT7_API_KEY=YOUR_API_KEY" https://mcp.contex
</details>
-<details>
-<summary><b>Install in Google Antigravity</b></summary>
-
-Add this to your Antigravity MCP config file. See [Antigravity MCP docs](https://antigravity.google/docs/mcp) for more info.
-
-#### Google Antigravity Remote Server Connection
-
-```json
-{
- "mcpServers": {
- "context7": {
- "serverUrl": "https://mcp.context7.com/mcp",
- "headers": {
- "CONTEXT7_API_KEY": "YOUR_API_KEY"
- }
- }
- }
-}
-```
-
-#### Google Antigravity Local Server Connection
-
-```json
-{
- "mcpServers": {
- "context7": {
- "command": "npx",
- "args": ["-y", "@upstash/context7-mcp", "--api-key", "YOUR_API_KEY"]
- }
- }
-}
-```
-
-</details>
-
<details>
<summary><b>Install in Windsurf</b></summary>
@@ -315,6 +280,72 @@ Or you can directly edit MCP servers configuration:
</details>
+<details>
+<summary><b>Install in Zed</b></summary>
+
+It can be installed via [Zed Extensions](https://zed.dev/extensions?query=Context7) or you can add this to your Zed `settings.json`. See [Zed Context Server docs](https://zed.dev/docs/assistant/context-servers) for more info.
+
+```json
+{
+ "context_servers": {
+ "Context7": {
+ "source": "custom",
+ "command": "npx",
+ "args": ["-y", "@upstash/context7-mcp", "--api-key", "YOUR_API_KEY"]
+ }
+ }
+}
+```
+
+</details>
+
+<details>
+<summary><b>Install in Augment Code</b></summary>
+
+To configure Context7 MCP in Augment Code, you can use either the graphical interface or manual configuration.
+
+### **A. Using the Augment Code UI**
+
+1. Click the hamburger menu.
+2. Select **Settings**.
+3. Navigate to the **Tools** section.
+4. Click the **+ Add MCP** button.
+5. Enter the following command:
+
+ ```
+ npx -y @upstash/context7-mcp@latest
+ ```
+
+6. Name the MCP: **Context7**.
+7. Click the **Add** button.
+
+Once the MCP server is added, you can start using Context7's up-to-date code documentation features directly within Augment Code.
+
+---
+
+### **B. Manual Configuration**
+
+1. Press Cmd/Ctrl Shift P or go to the hamburger menu in the Augment panel
+2. Select Edit Settings
+3. Under Advanced, click Edit in settings.json
+4. Add the server configuration to the `mcpServers` array in the `augment.advanced` object
+
+```json
+"augment.advanced": {
+ "mcpServers": [
+ {
+ "name": "context7",
+ "command": "npx",
+ "args": ["-y", "@upstash/context7-mcp", "--api-key", "YOUR_API_KEY"]
+ }
+ ]
+}
+```
+
+Once the MCP server is added, restart your editor. If you receive any errors, check the syntax to make sure closing brackets or commas are not missing.
+
+</details>
+
<details>
<summary><b>Install in Kilo Code</b></summary>
@@ -342,6 +373,7 @@ If a server is defined in both places, the **project-level configuration overrid
`https://mcp.context7.com/mcp`
**Headers → Add Header**
+
- **Key:** `Authorization`
- **Value:** `Bearer YOUR_API_KEY`
@@ -386,69 +418,38 @@ Kilo Code will automatically detect and load the configuration.
</details>
<details>
-<summary><b>Install in Zed</b></summary>
+<summary><b>Install in Google Antigravity</b></summary>
-It can be installed via [Zed Extensions](https://zed.dev/extensions?query=Context7) or you can add this to your Zed `settings.json`. See [Zed Context Server docs](https://zed.dev/docs/assistant/context-servers) for more info.
+Add this to your Antigravity MCP config file. See [Antigravity MCP docs](https://antigravity.google/docs/mcp) for more info.
+
+#### Google Antigravity Remote Server Connection
```json
{
- "context_servers": {
- "Context7": {
- "source": "custom",
- "command": "npx",
- "args": ["-y", "@upstash/context7-mcp", "--api-key", "YOUR_API_KEY"]
+ "mcpServers": {
+ "context7": {
+ "serverUrl": "https://mcp.context7.com/mcp",
+ "headers": {
+ "CONTEXT7_API_KEY": "YOUR_API_KEY"
+ }
}
}
}
```
-</details>
-
-<details>
-<summary><b>Install in Augment Code</b></summary>
-
-To configure Context7 MCP in Augment Code, you can use either the graphical interface or manual configuration.
-
-### **A. Using the Augment Code UI**
-
-1. Click the hamburger menu.
-2. Select **Settings**.
-3. Navigate to the **Tools** section.
-4. Click the **+ Add MCP** button.
-5. Enter the following command:
-
- ```
- npx -y @upstash/context7-mcp@latest
- ```
-
-6. Name the MCP: **Context7**.
-7. Click the **Add** button.
-
-Once the MCP server is added, you can start using Context7's up-to-date code documentation features directly within Augment Code.
-
----
-
-### **B. Manual Configuration**
-
-1. Press Cmd/Ctrl Shift P or go to the hamburger menu in the Augment panel
-2. Select Edit Settings
-3. Under Advanced, click Edit in settings.json
-4. Add the server configuration to the `mcpServers` array in the `augment.advanced` object
+#### Google Antigravity Local Server Connection
```json
-"augment.advanced": {
- "mcpServers": [
- {
- "name": "context7",
+{
+ "mcpServers": {
+ "context7": {
"command": "npx",
"args": ["-y", "@upstash/context7-mcp", "--api-key", "YOUR_API_KEY"]
}
- ]
+ }
}
```
-Once the MCP server is added, restart your editor. If you receive any errors, check the syntax to make sure closing brackets or commas are not missing.
-
</details>
<details>
@@ -1294,6 +1295,7 @@ Once configured, Context7 tools will be available in your droid sessions. Type `
[Emdash](https://github.com/generalaction/emdash) is an orchestration layer for running multiple coding agents in parallel. Provider-agnostic, worktree-isolated, and local-first. Emdash supports Context7 MCP to enable Context7 for your agents.
**What Emdash provides:**
+
- Global toggle: Settings → MCP → "Enable Context7 MCP"
- Per-workspace enable: The Context7 button in the ProviderBar (off by default). First click enables it for that workspace. Clicking again disables it.
- ProviderBar: The Context7 button shows status, a short explanation, and a link to docs
diff --git a/docs/installation.mdx b/docs/installation.mdx
index 318d173d..f3731cf5 100644
--- a/docs/installation.mdx
+++ b/docs/installation.mdx
@@ -30,11 +30,12 @@ After installing Context7 (see instructions below), enhance your workflow by add
- Or the equivalent in your MCP client
**Example Rule:**
+
```txt
-Always use context7 when I need code generation, setup or
-configuration steps, or library/API documentation. This means
-you should automatically use the Context7 MCP tools to resolve
-library id and get library docs without me having to
+Always use context7 when I need code generation, setup or
+configuration steps, or library/API documentation. This means
+you should automatically use the Context7 MCP tools to resolve
+library id and get library docs without me having to
explicitly ask.
```