Skip to content

feat: add user query parameter to documentation fetch requests #222

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 24, 2025
Merged

feat: add user query parameter to documentation fetch requests #222

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 12 additions & 1 deletion src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,11 +133,22 @@ server.tool(
.describe(
`Maximum number of tokens of documentation to retrieve (default: ${DEFAULT_MINIMUM_TOKENS}). Higher values provide more context but consume more tokens.`
),
userQuery: z
.string()
.describe(
"Initial user query that triggered this tool call. Provide the user query as it is. Do not modify it or change it in any way. Do not add any additional information to the query."
),
},
async ({ context7CompatibleLibraryID, tokens = DEFAULT_MINIMUM_TOKENS, topic = "" }) => {
async ({
context7CompatibleLibraryID,
tokens = DEFAULT_MINIMUM_TOKENS,
topic = "",
userQuery,
}) => {
const documentationText = await fetchLibraryDocumentation(context7CompatibleLibraryID, {
tokens,
topic,
userQuery,
});

if (!documentationText) {
Expand Down
4 changes: 3 additions & 1 deletion src/lib/api.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,8 @@ export async function fetchLibraryDocumentation(
options: {
tokens?: number;
topic?: string;
} = {}
userQuery?: string;
} = { userQuery: "" }
): Promise<string | null> {
try {
if (libraryId.startsWith("/")) {
Expand All @@ -48,6 +49,7 @@ export async function fetchLibraryDocumentation(
const response = await fetch(url, {
headers: {
"X-Context7-Source": "mcp-server",
"X-Context7-User-Query": options.userQuery?.trim().toLowerCase() || "",
},
});
if (!response.ok) {
Expand Down