context7

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Context7 Documentation Lookup Skill

Context7 文档查询Skill

Fetch current library documentation, API references, and code examples without MCP context overhead.
无需MCP上下文开销,获取最新的库文档、API参考和代码示例。

When to Use This Skill

何时使用该Skill

When the user asks about library APIs or framework patterns, use this skill to fetch current documentation.
When encountering import statements (
import
,
require
,
from
), use this skill to provide accurate API information.
When the user asks about specific library versions or "How do I use X library?", use this skill to get official patterns.
当用户询问库API或框架模式时,使用该Skill获取最新文档。
当遇到导入语句(
import
require
from
)时,使用该Skill提供准确的API信息。
当用户询问特定库版本或"如何使用X库?"时,使用该Skill获取官方模式。

Core Workflow

核心工作流程

To answer questions about library documentation, follow these steps:
  1. Search for the library ID using
    scripts/context7.sh search
  2. Fetch documentation using
    scripts/context7.sh docs
  3. Apply returned documentation to provide accurate, version-specific answers
要回答关于库文档的问题,请遵循以下步骤:
  1. 使用
    scripts/context7.sh search
    搜索库ID
  2. 使用
    scripts/context7.sh docs
    获取文档
  3. 利用返回的文档提供准确的、特定版本的答案

Running Scripts

运行脚本

Searching for Libraries

搜索库

To find a library ID for documentation lookup:
bash
scripts/context7.sh search "library-name"
This returns library IDs in the format
/vendor/library
(e.g.,
/facebook/react
).
要查找用于文档查询的库ID:
bash
scripts/context7.sh search "library-name"
它将返回格式为
/vendor/library
的库ID(例如
/facebook/react
)。

Fetching Documentation

获取文档

To fetch documentation for a specific library:
bash
scripts/context7.sh docs "<library-id>" "[topic]" "[mode]"
Parameters:
  • library-id
    (required): From search result (e.g.,
    /facebook/react
    )
  • topic
    (optional): Focus area (e.g.,
    hooks
    ,
    routing
    ,
    authentication
    )
  • mode
    (optional):
    code
    for API references (default) or
    info
    for conceptual guides
要获取特定库的文档:
bash
scripts/context7.sh docs "<library-id>" "[topic]" "[mode]"
参数:
  • library-id
    (必填):来自搜索结果(例如
    /facebook/react
  • topic
    (可选):重点领域(例如
    hooks
    routing
    authentication
  • mode
    (可选):
    code
    模式用于API参考(默认),
    info
    模式用于概念指南

Examples

示例

To get React hooks documentation:
bash
scripts/context7.sh search "react"
scripts/context7.sh docs "/facebook/react" "hooks" "code"
To get Next.js routing guide:
bash
scripts/context7.sh search "nextjs"
scripts/context7.sh docs "/vercel/next.js" "routing" "info"
要获取React hooks文档:
bash
scripts/context7.sh search "react"
scripts/context7.sh docs "/facebook/react" "hooks" "code"
要获取Next.js路由指南:
bash
scripts/context7.sh search "nextjs"
scripts/context7.sh docs "/vercel/next.js" "routing" "info"

Documentation Modes

文档模式

When fetching API references, examples, or code patterns, use
code
mode (default).
When fetching conceptual guides, tutorials, or explanations, use
info
mode.
当获取API参考、示例或代码模式时,使用
code
模式(默认)。
当获取概念指南、教程或解释时,使用
info
模式。

Environment Configuration

环境配置

To use authenticated requests (optional), set the
CONTEXT7_API_KEY
environment variable:
bash
export CONTEXT7_API_KEY="your-api-key"

要使用经过身份验证的请求(可选),设置
CONTEXT7_API_KEY
环境变量:
bash
export CONTEXT7_API_KEY="your-api-key"