Context7 Platform -- Up-to-date docs for AI agents
feat: add searchFilterApplied field to LibrarySearchResponse and SearchResponse interfaces; add warnings to cli and mcp (#2160)
Enes Gules9de3f0627c78
diff --git a/.changeset/bright-kings-fry.md b/.changeset/bright-kings-fry.mdnew file mode 100644index 00000000..46b009cb--- /dev/null+++ b/.changeset/bright-kings-fry.md@@ -0,0 +1,6 @@+---+"ctx7": patch+"@upstash/context7-mcp": patch+---++Display warning when public library access filter is being used to filter libraries.diff --git a/packages/cli/src/commands/docs.ts b/packages/cli/src/commands/docs.tsindex 4fdccf4a..3427b85c 100644--- a/packages/cli/src/commands/docs.ts+++ b/packages/cli/src/commands/docs.ts@@ -91,6 +91,14 @@ async function resolveCommand(}log.blank();++ if (data.searchFilterApplied) {+ log.warn(+ "Your results only include libraries matching your access settings. To search across all public libraries, update your settings at https://context7.com/dashboard?tab=libraries"+ );+ log.blank();+ }+for (let i = 0; i < results.length; i++) {log.plain(formatLibraryResult(results[i], i));log.blank();diff --git a/packages/cli/src/commands/generate.ts b/packages/cli/src/commands/generate.tsindex 0aab3888..172f727a 100644--- a/packages/cli/src/commands/generate.ts+++ b/packages/cli/src/commands/generate.ts@@ -163,6 +163,13 @@ async function generateCommand(options: GenerateOptions): Promise<void> {searchSpinner.succeed(pc.green(`Found ${searchResult.results.length} relevant sources`));log.blank();+ if (searchResult.searchFilterApplied) {+ log.warn(+ "Your results only include libraries matching your access settings. To search across all public libraries, update your settings at https://context7.com/dashboard?tab=libraries"+ );+ log.blank();+ }+let selectedLibraries: LibrarySearchResult[];try {const formatProjectId = (id: string) => {diff --git a/packages/cli/src/types.ts b/packages/cli/src/types.tsindex 90735772..143339e5 100644--- a/packages/cli/src/types.ts+++ b/packages/cli/src/types.ts@@ -57,6 +57,7 @@ export interface LibrarySearchResult {export interface LibrarySearchResponse {results: LibrarySearchResult[];+ searchFilterApplied?: boolean;error?: string;message?: string;}@@ -216,12 +217,6 @@ export interface SkillQuotaResponse {error?: string;}-export interface LibraryResolveResponse {- results: LibrarySearchResult[];- error?: string;- message?: string;-}-export interface CodeExample {language: string;code: string;diff --git a/packages/cli/src/utils/api.ts b/packages/cli/src/utils/api.tsindex acebe31c..44eb3047 100644--- a/packages/cli/src/utils/api.ts+++ b/packages/cli/src/utils/api.ts@@ -9,7 +9,6 @@ import type {StructuredGenerateInput,GenerateStreamEvent,SkillQuotaResponse,- LibraryResolveResponse,ContextResponse,} from "../types.js";import { downloadSkillFromGitHub } from "./github.js";@@ -267,7 +266,7 @@ export async function resolveLibrary(libraryName: string,query?: string,accessToken?: string-): Promise<LibraryResolveResponse> {+): Promise<LibrarySearchResponse> {const params = new URLSearchParams({ libraryName });if (query) {params.set("query", query);@@ -289,7 +288,7 @@ export async function resolveLibrary(};}- return (await response.json()) as LibraryResolveResponse;+ return (await response.json()) as LibrarySearchResponse;}export interface GetContextOptions {diff --git a/packages/mcp/src/lib/types.ts b/packages/mcp/src/lib/types.tsindex 287fbc79..e25ae758 100644--- a/packages/mcp/src/lib/types.ts+++ b/packages/mcp/src/lib/types.ts@@ -17,6 +17,7 @@ export interface SearchResult {export interface SearchResponse {error?: string;results: SearchResult[];+ searchFilterApplied?: boolean;}// Version state is still needed for validating search resultsdiff --git a/packages/mcp/src/lib/utils.ts b/packages/mcp/src/lib/utils.tsindex 66883a77..7b22cf4e 100644--- a/packages/mcp/src/lib/utils.ts+++ b/packages/mcp/src/lib/utils.ts@@ -68,8 +68,18 @@ export function formatSearchResults(searchResponse: SearchResponse): string {return "No documentation libraries found matching your query.";}+ const parts: string[] = [];++ if (searchResponse.searchFilterApplied) {+ parts.push(+ "**Note:** Your results only include libraries matching your access settings. To search across all public libraries, update your settings at https://context7.com/dashboard?tab=libraries"+ );+ }+const formattedResults = searchResponse.results.map(formatSearchResult);- return formattedResults.join("\n----------\n");+ parts.push(formattedResults.join("\n----------\n"));++ return parts.join("\n\n");}/**