How-To Guides

​

Quick Wins

• Auto-invoke Context7 so you never forget to pull fresh docs
• Target the exact library ID to skip search steps
• Tune networking and proxies for locked-down environments
• Control token usage to keep responses snappy
• Bring in private repositories for internal docs

​

Auto-Invoke Context7

​

Add a Rule to Your MCP Client

Always use context7 when I need code generation, setup steps, or library documentation.
Automatically use Context7 MCP tools without me having to ask.

Use context7 for all code generation and API documentation questions.

Automatically use context7 for code generation and library documentation.

​

Use Specific Library IDs

​

How to Find Library IDs

1. Visit context7.com
2. Search for your library
3. The ID is shown in the format /owner/repository

​

Use in Your Prompts

Implement JWT auth with Supabase. use library /supabase/supabase

Build a rate limiter. use library /upstash/ratelimit

Set up Next.js middleware. use library /vercel/next.js/v15.1.0

​

Benefits

• Faster: No library resolution needed
• Precise: Get docs for the exact library and version
• Reliable: No ambiguity about which library to use

​

Configure HTTPS Proxy

​

Set Environment Variables

export https_proxy=http://proxy.example.com:8080
export HTTPS_PROXY=http://proxy.example.com:8080

export https_proxy=http://username:password@proxy.example.com:8080

set https_proxy=http://proxy.example.com:8080
set HTTPS_PROXY=http://proxy.example.com:8080

set https_proxy=http://username:password@proxy.example.com:8080

$env:https_proxy = "http://proxy.example.com:8080"
$env:HTTPS_PROXY = "http://proxy.example.com:8080"

​

Or Configure in MCP Settings

{
  "mcpServers": {
    "context7": {
      "command": "npx",
      "args": ["-y", "@upstash/context7-mcp", "--api-key", "YOUR_API_KEY"],
      "env": {
        "https_proxy": "http://proxy.example.com:8080",
        "HTTPS_PROXY": "http://proxy.example.com:8080"
      }
    }
  }
}

​

Control Token Usage

​

Set Token Limits in Dashboard

1. Go to Dashboard → Libraries
2. Set “Maximum tokens per request”
3. Default is 10,000, adjust based on your needs

​

Use Topic Filtering

Explain Next.js middleware authentication patterns. use context7

​

Direct API Usage

curl "https://context7.com/api/v1/vercel/next.js?tokens=3000&topic=routing" \
  -H "Authorization: Bearer YOUR_API_KEY"

​

Work with Private Repositories

​

Requirements

• Pro plan ($7/seat/month)
• GitHub, GitLab, or Bitbucket account connection
• Repository access permissions

​

Add a Private Repository

1. Go to Dashboard → Libraries → Private Repositories
2. Click Add Private Repository
3. Choose your source:
   • Connect Repository: Link your GitHub, GitLab, or Bitbucket account
   • Upload OpenAPI Docs: Upload your own OpenAPI documentation
4. Enter repository URL (if connecting a repository)
5. Authorize Context7 to access your repository
6. Configure folders and exclusions (optional)
7. Submit

​

Cost

• Adding: $15 per 1M tokens parsed (one-time)
• Refreshing: Only pay for new/changed content
• Querying: Free (covered by seat cost)

​

Set Up Team Collaboration

​

Create a Team Project

1. Visit Dashboard
2. Click Create Team Project
3. Name your project

​

Invite Team Members

1. Go to Dashboard → Members
2. Click Invite Member
3. Enter their email and select a role:
   • Owner: Full control
   • Admin: Manage team and settings
   • Developer: API access only

​

Manage API Keys

​

Refresh Library Documentation

​

Web Interface

1. Go to context7.com/refresh-library
2. Enter library ID (e.g., /vercel/next.js)
3. Submit

​

API

POST https://context7.com/api/v1/refresh
Content-Type: application/json
Authorization: Bearer YOUR_API_KEY

{
  "docsRepoUrl": "https://github.com/vercel/next.js"
}

​

When to Refresh

• After major version releases
• When documentation is updated
• When you notice outdated information

​

Monitor Usage

​

View Statistics

• Search requests: Library searches
• Query/fetch requests: Documentation retrievals
• Query tokens: Tokens returned in responses
• Parsing tokens: Tokens processed when adding/refreshing

​

Understand Costs

• Seats: $7/month × team members
• Parse tokens: $15 per 1M tokens (private repos only)

• 4 team members: $28/month
• Added 800K token private repo: $12 one-time
• Monthly total: $40

​

Best Practices

​

Security

• Never commit API keys to version control. Use .env files and add them to .gitignore.
• Use environment variables for keys, like: export CONTEXT7_API_KEY=your_key_here.
• Rotate keys regularly — every 90 days or immediately if compromised.
• Grant only the permissions a team member needs. Use the “Developer” role for non-admins.

​

Performance

• Use specific library IDs such as /vercel/next.js instead of general phrases like “next.js docs” when possible.
• Set appropriate token limits — use lower values for quick lookups, and higher values for comprehensive docs.
• Focus results using topic filtering. Try adding specific topics like “authentication” or “routing”.
• Cache frequently used documentation locally for 6-24 hours to reduce API calls.

​

Library Management

• Keep the context7.json file in your repositories up to date. Update it when adding new docs or changing structure.
• Exclude unnecessary folders, such as tests and build artifacts: excludeFolders: ["test", "dist", "node_modules"].
• Add helpful rules for AI agents, such as “Always validate user input” or “Use TypeScript strict mode”.
• Maintain version tags for important releases. For example, keep v1.x docs available even after releasing v2.x.

​

Need Help?

• Troubleshooting: Common issues and solutions
• API Reference: Complete API documentation
• MCP Details: Technical MCP server info
• Community: Join our Discord