Get Context#

Retrieve documentation context for a specific library. Returns documentation as a JSON array of documentation snippets (default) or as plain text.

Arguments#

querystringrequired#

The user's question or task (used for relevance ranking)

libraryIdstringrequired#

The library ID (e.g., /facebook/react)

optionsGetContextOptions#

Show properties

type'json' | 'txt'#

Format of the response

json: Array of Documentation objects (default)
txt: Plain text format

Default: "json"

signalAbortSignal#

Abort signal for cancelling this request.

timeoutnumber | false#

Per-request timeout in milliseconds. Use false to disable the client timeout.

cacheCacheSetting#

Native fetch cache mode. Use false to omit the cache option.

Response#

The response type depends on the type option.

JSON Format (`type: "json"` or default)#

Returns Documentation[] - an array of documentation objects.

Text Format (`type: "txt"`)#

Returns a string containing the documentation context ready to use in LLM prompts.

Documentationobject#

Show properties

titlestringrequired#

Title of the documentation snippet

contentstringrequired#

The documentation content (includes code blocks in markdown format)

sourcestringrequired#

Source identifier for the snippet

Examples#

Use Cases#

Providing Context to LLMs#

import { Context7 } from "@upstash/context7-sdk";const client = new Context7();async function getDocsForPrompt(library: string, question: string) {  const context = await client.getContext(question, library);  return `Here is the relevant documentation:${context}User question: ${question}`;}const prompt = await getDocsForPrompt("/facebook/react", "How do I use useEffect?");

Processing Individual Snippets#

import { Context7 } from "@upstash/context7-sdk";const client = new Context7();const docs = await client.getContext(  "How to create components?",  "/facebook/react",  { type: "json" });docs.forEach((doc) => {  console.log(`Title: ${doc.title}`);  console.log(`Source: ${doc.source}`);  console.log(`Content length: ${doc.content.length} chars`);});