Search Library#

Search across available libraries. Returns an array of matching libraries with metadata useful for selection.

Arguments#

querystringrequired#

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

libraryNamestringrequired#

The library name to search for

Response#

Returns Library[] - an array of library objects.

Libraryobject#

Show properties

idstringrequired#

Unique identifier for the library (e.g., /facebook/react)

namestringrequired#

Display name of the library

descriptionstringrequired#

Brief description of the library

totalSnippetsnumberrequired#

Total number of documentation snippets available

trustScorenumberrequired#

Trust score of the library

benchmarkScorenumberrequired#

Benchmark score indicating documentation quality

versionsstring[]#

Available versions

Examples#

Use Cases#

Finding Libraries by Score#

const libraries = await client.searchLibrary("state management", "redux");const trusted = libraries.sort((a, b) => b.trustScore - a.trustScore);console.log("Most trusted:", trusted[0].name);

Checking Available Versions#

const libraries = await client.searchLibrary("I want to use lodash", "lodash");const library = libraries[0];if (library.versions) {  console.log(`Available versions: ${library.versions.join(", ")}`);}

Full Workflow#

import { Context7 } from "@upstash/context7-sdk";const client = new Context7();const libraries = await client.searchLibrary(  "I want to build a React app",  "react");const library = libraries[0];console.log(`Using: ${library.name} (${library.id})`);const context = await client.getContext(  "How do I create a component?",  library.id);console.log(context);