Skip to content

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

feat: update stale docs (#2307)

Enes Gules58a36cea87ea
diff --git a/docs/adding-libraries.mdx b/docs/adding-libraries.mdx
index c3da66e7..9d745576 100644
--- a/docs/adding-libraries.mdx
+++ b/docs/adding-libraries.mdx
@@ -32,7 +32,7 @@ The fastest way to add a library is through our web interface:
3. Submit and let Context7 parse and index the documentation.
<Note>
- For private repositories, see the [Private Repositories](/howto/private-repositories) guide.
+ For private sources, see the [Private Sources](/howto/private-sources) guide.
Requires a Pro or Enterprise plan.
</Note>
diff --git a/docs/docs.json b/docs/docs.json
index b0f0634b..e5e96fb6 100644
--- a/docs/docs.json
+++ b/docs/docs.json
@@ -44,7 +44,7 @@
"howto/claiming-libraries",
"howto/chat-widget",
"howto/verification",
- "howto/private-repositories",
+ "howto/private-sources",
"howto/teamspace",
"howto/usage"
]
@@ -139,6 +139,7 @@
{
"group": "Integrations",
"pages": [
+ "integrations/github-actions",
"integrations/code-rabbit"
]
},
diff --git a/docs/howto/chat-widget.mdx b/docs/howto/chat-widget.mdx
index 41a418d3..d8a9b910 100644
--- a/docs/howto/chat-widget.mdx
+++ b/docs/howto/chat-widget.mdx
@@ -9,6 +9,8 @@ The widget is a lightweight JavaScript snippet that renders a floating chat butt
<Note>The chat widget is available to library owners who have [claimed their library](/howto/claiming-libraries).</Note>
+![Chat widget panel showing AI-powered documentation assistant](/images/dashboard/chat-widget.png)
+
## How It Works
1. A visitor clicks the chat bubble on your site
diff --git a/docs/howto/private-repositories.mdx b/docs/howto/private-repositories.mdx
deleted file mode 100644
index 9afbb2dd..00000000
--- a/docs/howto/private-repositories.mdx
+++ /dev/null
@@ -1,77 +0,0 @@
----
-title: Add Private Repositories
-description: Add and manage private repository documentation
----
-
-Add your private GitHub, GitLab, or Bitbucket repositories to Context7 to make your internal documentation available to AI coding assistants.
-
-![Private Repositories card showing a table of added repositories](/images/dashboard/private-repos-card.png)
-
-## Adding Private Repositories
-
-Follow these steps to add a private repository:
-
-1. Go to the [Add Library](https://context7.com/add-library) page
-2. **Connect your account**
- - Choose GitHub, GitLab, or Bitbucket
- - Authorize Context7 to access your repositories
-3. **Select a repository** from your account
-4. **Submit** for parsing
-
-<Note>You must have a Pro or Enterprise plan to add private repositories.</Note>
-
-## Repository Management
-
-### Refreshing Documentation
-
-Keep your private documentation up to date:
-
-1. **Click "Refresh"** next to the repository
-2. Context7 re-parses the repository
-3. **You're only charged for changed content** - cached pages are free
-
-**When to refresh**:
-
-- After major documentation updates
-- After releasing new features
-- When you notice outdated information
-
-<Tip>Refresh private repos only after significant documentation changes to minimize costs.</Tip>
-
-### Removing Repositories
-
-To remove a private repository:
-
-1. **Click "Remove"** next to the repository
-2. **Confirm deletion** in the modal
-3. Repository documentation becomes unavailable immediately
-
-<Warning>
- This action is permanent. The repository will no longer be accessible via the API.
-</Warning>
-
-## Permissions
-
-Access to private repository management is restricted by role. Only Owners and Admins can add, refresh, or remove private repositories. Developers can view repository documentation but cannot manage repositories.
-
-See [Teamspace Management](/howto/teamspace#roles) for the complete permissions table.
-
-## Configuration
-
-### Using `context7.json`
-
-Add a `context7.json` file to your repository root for better control over parsing:
-
-```json
-{
- "$schema": "https://context7.com/schema/context7.json",
- "projectTitle": "Your Project Name",
- "description": "Brief description of your project",
- "folders": ["docs", "guides"],
- "excludeFolders": ["tests", "dist", "node_modules"],
- "excludeFiles": ["CHANGELOG.md"],
- "rules": ["Always validate user input", "Use TypeScript strict mode"]
-}
-```
-
-See the [Adding Libraries](/adding-libraries) page for complete configuration options.
diff --git a/docs/howto/private-sources.mdx b/docs/howto/private-sources.mdx
new file mode 100644
index 00000000..6a89469f
--- /dev/null
+++ b/docs/howto/private-sources.mdx
@@ -0,0 +1,82 @@
+---
+title: Add Private Sources
+description: Add and manage private source documentation
+---
+
+Add private sources to Context7 to make your internal documentation available to AI coding assistants. You can add sources from GitHub, GitLab, Bitbucket, other Git providers, Confluence, and OpenAPI specifications.
+
+![Private Sources card showing a table of added sources and source type options](/images/dashboard/private-sources-card.png)
+
+## Adding Private Sources
+
+Follow these steps to add a private source:
+
+1. Go to your teamspace's **Sources** tab
+2. **Click "Add another"** to open the source type selector
+3. **Select a source type**:
+ - **GitHub** — connect your GitHub account and select a repository
+ - **GitLab** — connect your GitLab account and select a project
+ - **Bitbucket** — connect your Bitbucket account and select a repository
+ - **Other Git** — add any Git repository by URL
+ - **Confluence** — connect your Confluence workspace
+ - **OpenAPI** — add an OpenAPI specification
+4. **Authorize** Context7 to access your source (if required)
+5. **Submit** for parsing
+
+<Note>You must have a Pro or Enterprise plan to add private sources. Public sources can be added from the [Add Library](https://context7.com/add-library) page.</Note>
+
+## Source Management
+
+### Refreshing Documentation
+
+Keep your private documentation up to date:
+
+1. **Click the refresh icon** next to the source
+2. Context7 re-parses the source
+3. **You're only charged for changed content** — cached pages are free
+
+**When to refresh**:
+
+- After major documentation updates
+- After releasing new features
+- When you notice outdated information
+
+<Tip>Refresh private sources only after significant documentation changes to minimize costs.</Tip>
+
+### Removing Sources
+
+To remove a private source:
+
+1. **Click the trash icon** next to the source
+2. **Confirm deletion** in the modal
+3. Source documentation becomes unavailable immediately
+
+<Warning>
+ This action is permanent. The source will no longer be accessible via the API.
+</Warning>
+
+## Permissions
+
+Access to private source management is restricted by role. Only Owners and Admins can add, refresh, or remove private sources. Developers can view source documentation but cannot manage sources.
+
+See [Teamspace Management](/howto/teamspace#roles) for the complete permissions table.
+
+## Configuration
+
+### Using `context7.json`
+
+Add a `context7.json` file to your repository root for better control over parsing:
+
+```json
+{
+ "$schema": "https://context7.com/schema/context7.json",
+ "projectTitle": "Your Project Name",
+ "description": "Brief description of your project",
+ "folders": ["docs", "guides"],
+ "excludeFolders": ["tests", "dist", "node_modules"],
+ "excludeFiles": ["CHANGELOG.md"],
+ "rules": ["Always validate user input", "Use TypeScript strict mode"]
+}
+```
+
+See the [Adding Libraries](/adding-libraries) page for complete configuration options.
diff --git a/docs/howto/teamspace.mdx b/docs/howto/teamspace.mdx
index 38412371..596f6126 100644
--- a/docs/howto/teamspace.mdx
+++ b/docs/howto/teamspace.mdx
@@ -42,7 +42,7 @@ Add team members, assign roles, and manage access to your Context7 dashboard fro
If you are the owner of the teamspace, you can rename or delete the teamspace under the overview tab.
-![Teamspace management card](/images/dashboard/team-management-card.png)
+![Teamspace management card](/images/dashboard/teamspace-management.png)
<Warning>Deleting a teamspace is permanent. All members lose access immediately.</Warning>
diff --git a/docs/howto/usage.mdx b/docs/howto/usage.mdx
index 43a9fc6b..dcb7e0d4 100644
--- a/docs/howto/usage.mdx
+++ b/docs/howto/usage.mdx
@@ -3,59 +3,35 @@ title: Monitor Usage
description: Monitor your Context7 API usage and track costs
---
-Track your Context7 usage with real-time metrics from the Overview tab.
+Track your Context7 usage with real-time metrics from the **Overview** tab on your teamspace dashboard.
-![Usage statistics card showing metrics and cost breakdown](/images/dashboard/usage-stats.png)
+![Usage statistics card showing requests, parsing tokens, seats, and cost breakdown](/images/dashboard/usage-stats.png)
## Metrics Overview
-Context7 tracks four key metrics to help you understand your usage patterns:
+The Overview tab displays four metrics:
-### Search & Query Requests
+### Requests
-The total number of API calls made to Context7:
-
-- **Search Requests**: Library search queries
-- **Query Requests**: Documentation retrieval calls
-
-### Query Tokens
-
-The total number of tokens returned in API responses. This reflects how much documentation content you've retrieved.
-
-<Tip>Search requests, Query requests, and Query tokens do not affect cost.</Tip>
+The total number of API calls made to Context7, shown against your plan's included quota. Requests within your quota are free; excess requests are billed based on your plan.
### Parsing Tokens
-The total tokens processed when parsing private repository documentation (Pro and Enterprise only).
-
-**How it works**:
+The total tokens processed when parsing private source documentation (Pro and Enterprise only).
-- Charged when adding a new private repository
+- Charged when adding a new private source
- Charged for changed content when refreshing
- No charge for cached content when refreshing
-**Cost**: $25 per 1M tokens
-
-### Total Cost
-
-Your monthly cost in USD (Pro and Enterprise only).
-
-**Calculation**:
-
-```
-Total Cost = Parsing Cost + Teamspace Cost
+### Seats
-Parsing Cost = (Parsing Tokens / 1,000,000) × $25
-Teamspace Cost = Number of Members × $7
-```
+The number of members in your teamspace. Each seat is billed monthly based on your plan.
-**Example**:
+### Cost
-- Teamspace: 4 members
-- Parsing: 800K tokens this month
-- Cost: (800K / 1M × $25) + (4 × $7) = $20 + $28 = **$48**
+Your total monthly cost in USD, with a breakdown of each component: request overages, parsing tokens, and seats.
-Hover over the Total Cost to see the detailed breakdown.
+See [Plans & Pricing](https://context7.com/plans) for current rates and included quotas.
## Reporting Periods
diff --git a/docs/images/dashboard/admin/library-manage-button.png b/docs/images/dashboard/admin/library-manage-button.png
index fb946910..2cbacfab 100644
Binary files a/docs/images/dashboard/admin/library-manage-button.png and b/docs/images/dashboard/admin/library-manage-button.png differ
diff --git a/docs/images/dashboard/api-keys-card.png b/docs/images/dashboard/api-keys-card.png
index 84af1ba5..c1225a79 100644
Binary files a/docs/images/dashboard/api-keys-card.png and b/docs/images/dashboard/api-keys-card.png differ
diff --git a/docs/images/dashboard/chat-widget.png b/docs/images/dashboard/chat-widget.png
new file mode 100644
index 00000000..6250825f
Binary files /dev/null and b/docs/images/dashboard/chat-widget.png differ
diff --git a/docs/images/dashboard/library-access-card.png b/docs/images/dashboard/library-access-card.png
deleted file mode 100644
index 4b4fde07..00000000
Binary files a/docs/images/dashboard/library-access-card.png and /dev/null differ
diff --git a/docs/images/dashboard/library-access-selector.png b/docs/images/dashboard/library-access-selector.png
deleted file mode 100644
index 343011d0..00000000
Binary files a/docs/images/dashboard/library-access-selector.png and /dev/null differ
diff --git a/docs/images/dashboard/members-tab.png b/docs/images/dashboard/members-tab.png
index d0c943c1..333278ea 100644
Binary files a/docs/images/dashboard/members-tab.png and b/docs/images/dashboard/members-tab.png differ
diff --git a/docs/images/dashboard/private-repos-card.png b/docs/images/dashboard/private-repos-card.png
deleted file mode 100644
index 8feb56ee..00000000
Binary files a/docs/images/dashboard/private-repos-card.png and /dev/null differ
diff --git a/docs/images/dashboard/private-sources-card.png b/docs/images/dashboard/private-sources-card.png
new file mode 100644
index 00000000..e6317ffb
Binary files /dev/null and b/docs/images/dashboard/private-sources-card.png differ
diff --git a/docs/images/dashboard/public-repository-filters.png b/docs/images/dashboard/public-repository-filters.png
new file mode 100644
index 00000000..559c4969
Binary files /dev/null and b/docs/images/dashboard/public-repository-filters.png differ
diff --git a/docs/images/dashboard/source-type-access.png b/docs/images/dashboard/source-type-access.png
new file mode 100644
index 00000000..24fec832
Binary files /dev/null and b/docs/images/dashboard/source-type-access.png differ
diff --git a/docs/images/dashboard/team-management-card.png b/docs/images/dashboard/team-management-card.png
deleted file mode 100644
index 921b59bd..00000000
Binary files a/docs/images/dashboard/team-management-card.png and /dev/null differ
diff --git a/docs/images/dashboard/teamspace-management.png b/docs/images/dashboard/teamspace-management.png
new file mode 100644
index 00000000..db379c1d
Binary files /dev/null and b/docs/images/dashboard/teamspace-management.png differ
diff --git a/docs/images/dashboard/usage-stats.png b/docs/images/dashboard/usage-stats.png
index 214e400e..bfd1e4a4 100644
Binary files a/docs/images/dashboard/usage-stats.png and b/docs/images/dashboard/usage-stats.png differ
diff --git a/docs/images/dashboard/user-dropdown.png b/docs/images/dashboard/user-dropdown.png
index 7b9ccd39..c1545eea 100644
Binary files a/docs/images/dashboard/user-dropdown.png and b/docs/images/dashboard/user-dropdown.png differ
diff --git a/docs/integrations/github-actions.mdx b/docs/integrations/github-actions.mdx
new file mode 100644
index 00000000..b851a3dc
--- /dev/null
+++ b/docs/integrations/github-actions.mdx
@@ -0,0 +1,81 @@
+---
+title: GitHub Actions
+sidebarTitle: GitHub Actions
+description: Automatically refresh your Context7 library when your docs change
+---
+
+Keep your Context7 documentation in sync by triggering a refresh whenever you push to your main branch.
+
+## Setup
+
+<Steps>
+ <Step title="Get your API key">
+ Go to your [Context7 dashboard](https://context7.com/dashboard) and copy your API key.
+ </Step>
+ <Step title="Add the API key as a repository secret">
+ In your GitHub repository, go to **Settings** → **Secrets and variables** → **Actions** and add a new secret:
+
+ | Name | Value |
+ |------|-------|
+ | `CONTEXT7_API_KEY` | Your API key from the Context7 dashboard |
+ </Step>
+ <Step title="Create the workflow file">
+ Add the following file to your repository at `.github/workflows/context7-refresh.yml`:
+
+ ```yaml
+ name: Refresh Context7 Docs
+
+ on:
+ push:
+ branches:
+ - master # change to your default branch if different
+
+ jobs:
+ refresh:
+ runs-on: ubuntu-latest
+ steps:
+ - name: Trigger Context7 Refresh
+ run: |
+ curl -s -X POST https://context7.com/api/v1/refresh \
+ -H "Content-Type: application/json" \
+ -H "Authorization: Bearer ${{ secrets.CONTEXT7_API_KEY }}" \
+ -d '{"libraryName": "/${{ github.repository }}"}'
+ ```
+
+ This uses `${{ github.repository }}` to automatically resolve to your repository's `owner/repo` (e.g., `vercel/next.js`). If your library identifier on Context7 differs from your GitHub repository name, replace it with the correct value (e.g., `/your-org/your-repo`).
+ </Step>
+</Steps>
+
+## Refreshing a Specific Branch
+
+To refresh a non-default branch, add the `branch` field to the request body. The `branch` value must match a branch name that already exists on your library in Context7.
+
+```yaml
+- name: Trigger Context7 Refresh
+ run: |
+ curl -s -X POST https://context7.com/api/v1/refresh \
+ -H "Content-Type: application/json" \
+ -H "Authorization: Bearer ${{ secrets.CONTEXT7_API_KEY }}" \
+ -d '{"libraryName": "/your-org/your-repo", "branch": "v2"}'
+```
+
+<Note>
+ If the branch has not been added to your library on Context7, the refresh will fail with a `branch_not_found` error.
+</Note>
+
+## Private Repositories
+
+For private repositories, include a `gitToken` so Context7 can access your code:
+
+```yaml
+- name: Trigger Context7 Refresh
+ run: |
+ curl -s -X POST https://context7.com/api/v1/refresh \
+ -H "Content-Type: application/json" \
+ -H "Authorization: Bearer ${{ secrets.CONTEXT7_API_KEY }}" \
+ -d '{"libraryName": "/your-org/your-repo", "gitToken": "${{ secrets.GIT_ACCESS_TOKEN }}"}'
+```
+
+<Note>
+ Private sources require a Pro or Enterprise plan. See the [Private Sources](/howto/private-sources) guide for more details.
+</Note>
diff --git a/docs/security/architecture.mdx b/docs/security/architecture.mdx
index 10723059..6d6923f6 100644
--- a/docs/security/architecture.mdx
+++ b/docs/security/architecture.mdx
@@ -64,11 +64,34 @@ The Context7 MCP server is [open source](https://github.com/upstash/context7). I
</Warning>
## Customizing What Is Retrieved
-You can limit retrieval scope by specifying which libraries or organizations are accessible under `Public Library Access` in the **Libraries** tab on your Context7 dashboard.
-This lets you limit content to libraries you trust and prefer.
+
+You can control retrieval scope from the **Policies** tab on your teamspace dashboard.
+
+### Source Type Access
+
+Toggle which types of documentation sources are accessible to your teamspace:
+
+- **Public Repositories** — open-source repositories from GitHub, GitLab, and Bitbucket
+- **Websites** — documentation crawled from websites
+- **llms.txt** — documentation from llms.txt files
+- **Confluence** — Atlassian Confluence workspace pages and documentation
+- **Uploaded Files** — manually uploaded OpenAPI specifications
+- **Non-Verified Libraries** — libraries that have not been verified by their owners
+- **Private Sources** — private sources connected to this teamspace
+
+<Frame>
+![Source Type Access card showing toggles for each documentation source type](/images/dashboard/source-type-access.png)
+</Frame>
+
+### Public Repository Filters
+
+Restrict which public repositories are accessible to your teamspace. You can choose between two modes:
+
+- **Filter by Quality** — set criteria like minimum stars, minimum trust score, and recency or block specific libraries or organizations from appearing in results
+- **Select Manually** — pick specific libraries or organizations
<Frame>
-![Selecting libraries and organizations for retrieval](/images/dashboard/library-access-selector.png)
+![Public Repository Filters card showing quality filters and blocked libraries](/images/dashboard/public-repository-filters.png)
</Frame>
## Data Handling