How upstash/context7 works
Context7 delivers current, version-specific library documentation and source code to AI coding agents. The primary workflow is an agent invoking a Context7 tool, which resolves or uses a library ID, fetches documentation or code from the Context7 API, and returns results to the agent. The repository also provides CLI setup and authentication, client integrations, an SDK, and an administrative MCP console. Relationships below are limited to README statements and the supplied excerpts or SOURCE INDEX references; unsampled subsystem details are not inferred.
Main entry points: index.ts MCP entry · api.ts Context API · server.ts Admin MCP server · app.tsx Console UI
Components 26
MCP service
- MCP entry
packages/mcp/src/index.ts - Context API
packages/mcp/src/lib/api.ts - Library discovery
packages/mcp/src/lib/api.ts - Documentation query
packages/mcp/src/index.ts - Code query
packages/mcp/src/lib/query-code-tool.ts - Preview tools
packages/mcp/src/lib/research-preview-tools.ts - HTTP auth
packages/mcp/src/lib/mcp-http-auth.ts - Telemetry runtime
packages/mcp/src/lib/telemetry-runtime.ts
CLI setup
- CLI setup
packages/cli/src/commands/setup.ts - CLI authentication
packages/cli/src/commands/auth.ts - Credential handling
packages/cli/src/utils/auth.ts - Credential paths
packages/cli/src/utils/storage-paths.ts - CLI search
packages/cli/src/commands/search.ts
Client integrations
- JavaScript SDK
packages/sdk/src/client.ts - AI SDK tools
packages/tools-ai-sdk/src/tools/query-docs.ts - Pi integration
packages/pi/lib/tools/query-docs.ts - OpenCode integration
packages/opencode/src/index.ts
Admin console
- Admin MCP server
packages/admin-mcp/src/server.ts - Admin tools
packages/admin-mcp/src/tools.ts - Console UI
packages/admin-mcp/ui/src/app.tsx - Console data
packages/admin-mcp/ui/src/data.ts - Console components
packages/admin-mcp/ui/src/components.tsx - Console HTML
packages/admin-mcp/src/ui/console-html.ts
Other components
- AI coding agent
- Context7 API service
- CLI operator
Connections 23
- AI coding agent → MCP entry: invokes tools
README.md - MCP entry → Context API: uses API
packages/mcp/src/index.ts - MCP entry → Preview tools: registers tools
packages/mcp/src/index.ts - MCP entry → HTTP auth: configures auth
packages/mcp/src/index.ts - MCP entry → Telemetry runtime: configures telemetry
packages/mcp/src/index.ts - Preview tools → Code query: registers query
packages/mcp/src/lib/research-preview-tools.ts - Code query → Context API: fetches code
packages/mcp/src/lib/query-code-tool.ts - Library discovery → Context7 API service: searches libraries
packages/mcp/src/lib/api.ts - Context API → Context7 API service: requests data
packages/mcp/src/lib/api.ts - AI coding agent → JavaScript SDK: uses client
README.md - AI coding agent → AI SDK tools: uses tools
README.md - AI coding agent → Pi integration: uses integration
- AI coding agent → OpenCode integration: uses integration
- CLI operator → CLI setup: runs setup
README.md - CLI setup → CLI authentication: authenticates
- CLI authentication → Credential handling: starts login
packages/cli/src/commands/auth.ts - Credential handling → Credential paths: resolves paths
packages/cli/src/utils/auth.ts - CLI operator → CLI search: searches docs
- CLI operator → MCP entry: configures MCP
README.md - Admin MCP server → Admin tools: runs tools
packages/admin-mcp/src/server.ts - Console UI → Console components: renders components
packages/admin-mcp/ui/src/app.tsx - Console UI → Console data: uses data
packages/admin-mcp/ui/src/app.tsx - Admin MCP server → Console HTML: serves console