Skip to content

feat: add include_context option to return source code with results #39

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

Open
PiotrTrzpil wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat: add include_context option to return source code with results #39

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
198 changes: 176 additions & 22 deletions index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import { StdioServerTransport } from '@modelcontextprotocol/sdk/server/stdio.js'
import { CallToolRequestSchema, ListToolsRequestSchema } from '@modelcontextprotocol/sdk/types.js';
import { applyWorkspaceEdit } from './src/file-editor.js';
import { LSPClient } from './src/lsp-client.js';
import { uriToPath } from './src/utils.js';
import { formatLocationWithContext, uriToPath } from './src/utils.js';

// Handle subcommands
const args = process.argv.slice(2);
Expand Down Expand Up @@ -63,6 +63,18 @@ server.setRequestHandler(ListToolsRequestSchema, async () => {
type: 'string',
description: 'The kind of symbol (function, class, variable, method, etc.)',
},
include_context: {
type: 'boolean',
description:
'If true, include source code context around each result location (default: false)',
default: false,
},
context_lines: {
type: 'number',
description:
'Number of lines of context to include before and after the target line (default: 2)',
default: 2,
},
},
required: ['file_path', 'symbol_name'],
},
Expand Down Expand Up @@ -91,6 +103,18 @@ server.setRequestHandler(ListToolsRequestSchema, async () => {
description: 'Whether to include the declaration',
default: true,
},
include_context: {
type: 'boolean',
description:
'If true, include source code context around each result location (default: false)',
default: false,
},
context_lines: {
type: 'number',
description:
'Number of lines of context to include before and after the target line (default: 2)',
default: 2,
},
},
required: ['file_path', 'symbol_name'],
},
Expand Down Expand Up @@ -224,6 +248,18 @@ server.setRequestHandler(ListToolsRequestSchema, async () => {
type: 'string',
description: 'The symbol name or pattern to search for',
},
include_context: {
type: 'boolean',
description:
'If true, include source code context around each result location (default: false)',
default: false,
},
context_lines: {
type: 'number',
description:
'Number of lines of context to include before and after the target line (default: 2)',
default: 2,
},
},
required: ['query'],
},
Expand All @@ -247,6 +283,18 @@ server.setRequestHandler(ListToolsRequestSchema, async () => {
type: 'number',
description: 'The character position in the line (1-indexed)',
},
include_context: {
type: 'boolean',
description:
'If true, include source code context around each result location (default: false)',
default: false,
},
context_lines: {
type: 'number',
description:
'Number of lines of context to include before and after the target line (default: 2)',
default: 2,
},
},
required: ['file_path', 'line', 'character'],
},
Expand Down Expand Up @@ -293,6 +341,18 @@ server.setRequestHandler(ListToolsRequestSchema, async () => {
type: 'number',
description: 'The character position in the line (1-indexed)',
},
include_context: {
type: 'boolean',
description:
'If true, include source code context around each result location (default: false)',
default: false,
},
context_lines: {
type: 'number',
description:
'Number of lines of context to include before and after the target line (default: 2)',
default: 2,
},
},
required: ['file_path', 'line', 'character'],
},
Expand All @@ -316,6 +376,18 @@ server.setRequestHandler(ListToolsRequestSchema, async () => {
type: 'number',
description: 'The character position in the line (1-indexed)',
},
include_context: {
type: 'boolean',
description:
'If true, include source code context around each result location (default: false)',
default: false,
},
context_lines: {
type: 'number',
description:
'Number of lines of context to include before and after the target line (default: 2)',
default: 2,
},
},
required: ['file_path', 'line', 'character'],
},
Expand All @@ -329,12 +401,21 @@ server.setRequestHandler(CallToolRequestSchema, async (request) => {

try {
if (name === 'find_definition') {
const { file_path, symbol_name, symbol_kind } = args as {
const {
file_path,
symbol_name,
symbol_kind,
include_context = false,
context_lines = 2,
} = args as {
file_path: string;
symbol_name: string;
symbol_kind?: string;
include_context?: boolean;
context_lines?: number;
};
const absolutePath = resolve(file_path);
const contextOptions = { linesBefore: context_lines, linesAfter: context_lines };

const result = await lspClient.findSymbolsByName(absolutePath, symbol_name, symbol_kind);
const { matches: symbolMatches, warning } = result;
Expand Down Expand Up @@ -369,10 +450,16 @@ server.setRequestHandler(CallToolRequestSchema, async (request) => {
const locationResults = locations
.map((loc) => {
const filePath = uriToPath(loc.uri);
const { start, end } = loc.range;
return `${filePath}:${start.line + 1}:${start.character + 1}`;
const { start } = loc.range;
return formatLocationWithContext(
filePath,
start.line + 1,
start.character + 1,
include_context,
contextOptions
);
})
.join('\n');
.join(include_context ? '\n\n' : '\n');

results.push(
`Results for ${match.name} (${lspClient.symbolKindToString(match.kind)}) at ${file_path}:${match.position.line + 1}:${match.position.character + 1}:\n${locationResults}`
Expand Down Expand Up @@ -421,13 +508,18 @@ server.setRequestHandler(CallToolRequestSchema, async (request) => {
symbol_name,
symbol_kind,
include_declaration = true,
include_context = false,
context_lines = 2,
} = args as {
file_path: string;
symbol_name: string;
symbol_kind?: string;
include_declaration?: boolean;
include_context?: boolean;
context_lines?: number;
};
const absolutePath = resolve(file_path);
const contextOptions = { linesBefore: context_lines, linesAfter: context_lines };

const result = await lspClient.findSymbolsByName(absolutePath, symbol_name, symbol_kind);
const { matches: symbolMatches, warning } = result;
Expand Down Expand Up @@ -460,10 +552,16 @@ server.setRequestHandler(CallToolRequestSchema, async (request) => {
const locationResults = locations
.map((loc) => {
const filePath = uriToPath(loc.uri);
const { start, end } = loc.range;
return `${filePath}:${start.line + 1}:${start.character + 1}`;
const { start } = loc.range;
return formatLocationWithContext(
filePath,
start.line + 1,
start.character + 1,
include_context,
contextOptions
);
})
.join('\n');
.join(include_context ? '\n\n' : '\n');

results.push(
`Results for ${match.name} (${lspClient.symbolKindToString(match.kind)}) at ${file_path}:${match.position.line + 1}:${match.position.character + 1}:\n${locationResults}`
Expand Down Expand Up @@ -879,7 +977,12 @@ server.setRequestHandler(CallToolRequestSchema, async (request) => {
}

if (name === 'find_workspace_symbols') {
const { query } = args as { query: string };
const { query, include_context = false, context_lines = 2 } = args as {
query: string;
include_context?: boolean;
context_lines?: number;
};
const contextOptions = { linesBefore: context_lines, linesAfter: context_lines };

try {
const symbols = await lspClient.workspaceSymbol(query);
Expand All @@ -898,14 +1001,24 @@ server.setRequestHandler(CallToolRequestSchema, async (request) => {
const symbolList = symbols.map((sym) => {
const filePath = uriToPath(sym.location.uri);
const { start } = sym.location.range;
return `• ${sym.name} (${lspClient.symbolKindToString(sym.kind)}) at ${filePath}:${start.line + 1}:${start.character + 1}`;
const location = formatLocationWithContext(
filePath,
start.line + 1,
start.character + 1,
include_context,
contextOptions
);
if (include_context) {
return `• ${sym.name} (${lspClient.symbolKindToString(sym.kind)})\n ${location.replace(/\n/g, '\n ')}`;
}
return `• ${sym.name} (${lspClient.symbolKindToString(sym.kind)}) at ${location}`;
});

return {
content: [
{
type: 'text',
text: `Found ${symbols.length} symbol(s) matching "${query}":\n\n${symbolList.join('\n')}`,
text: `Found ${symbols.length} symbol(s) matching "${query}":\n\n${symbolList.join(include_context ? '\n\n' : '\n')}`,
},
],
};
Expand All @@ -922,12 +1035,15 @@ server.setRequestHandler(CallToolRequestSchema, async (request) => {
}

if (name === 'find_implementation') {
const { file_path, line, character } = args as {
const { file_path, line, character, include_context = false, context_lines = 2 } = args as {
file_path: string;
line: number;
character: number;
include_context?: boolean;
context_lines?: number;
};
const absolutePath = resolve(file_path);
const contextOptions = { linesBefore: context_lines, linesAfter: context_lines };

try {
const locations = await lspClient.findImplementation(absolutePath, {
Expand All @@ -949,14 +1065,20 @@ server.setRequestHandler(CallToolRequestSchema, async (request) => {
const locationList = locations.map((loc) => {
const filePath = uriToPath(loc.uri);
const { start } = loc.range;
return `${filePath}:${start.line + 1}:${start.character + 1}`;
return formatLocationWithContext(
filePath,
start.line + 1,
start.character + 1,
include_context,
contextOptions
);
});

return {
content: [
{
type: 'text',
text: `Found ${locations.length} implementation(s):\n\n${locationList.join('\n')}`,
text: `Found ${locations.length} implementation(s):\n\n${locationList.join(include_context ? '\n\n' : '\n')}`,
},
],
};
Expand Down Expand Up @@ -1024,12 +1146,15 @@ server.setRequestHandler(CallToolRequestSchema, async (request) => {
}

if (name === 'get_incoming_calls') {
const { file_path, line, character } = args as {
const { file_path, line, character, include_context = false, context_lines = 2 } = args as {
file_path: string;
line: number;
character: number;
include_context?: boolean;
context_lines?: number;
};
const absolutePath = resolve(file_path);
const contextOptions = { linesBefore: context_lines, linesAfter: context_lines };

try {
const items = await lspClient.prepareCallHierarchy(absolutePath, {
Expand All @@ -1054,9 +1179,22 @@ server.setRequestHandler(CallToolRequestSchema, async (request) => {
for (const call of calls) {
const filePath = uriToPath(call.from.uri);
const { start } = call.from.selectionRange;
allCalls.push(
`• ${call.from.name} (${lspClient.symbolKindToString(call.from.kind)}) at ${filePath}:${start.line + 1}:${start.character + 1}`
const location = formatLocationWithContext(
filePath,
start.line + 1,
start.character + 1,
include_context,
contextOptions
);
if (include_context) {
allCalls.push(
`• ${call.from.name} (${lspClient.symbolKindToString(call.from.kind)})\n ${location.replace(/\n/g, '\n ')}`
);
} else {
allCalls.push(
`• ${call.from.name} (${lspClient.symbolKindToString(call.from.kind)}) at ${location}`
);
}
}
}

Expand All @@ -1075,7 +1213,7 @@ server.setRequestHandler(CallToolRequestSchema, async (request) => {
content: [
{
type: 'text',
text: `Found ${allCalls.length} incoming call(s):\n\n${allCalls.join('\n')}`,
text: `Found ${allCalls.length} incoming call(s):\n\n${allCalls.join(include_context ? '\n\n' : '\n')}`,
},
],
};
Expand All @@ -1092,12 +1230,15 @@ server.setRequestHandler(CallToolRequestSchema, async (request) => {
}

if (name === 'get_outgoing_calls') {
const { file_path, line, character } = args as {
const { file_path, line, character, include_context = false, context_lines = 2 } = args as {
file_path: string;
line: number;
character: number;
include_context?: boolean;
context_lines?: number;
};
const absolutePath = resolve(file_path);
const contextOptions = { linesBefore: context_lines, linesAfter: context_lines };

try {
const items = await lspClient.prepareCallHierarchy(absolutePath, {
Expand All @@ -1122,9 +1263,22 @@ server.setRequestHandler(CallToolRequestSchema, async (request) => {
for (const call of calls) {
const filePath = uriToPath(call.to.uri);
const { start } = call.to.selectionRange;
allCalls.push(
`• ${call.to.name} (${lspClient.symbolKindToString(call.to.kind)}) at ${filePath}:${start.line + 1}:${start.character + 1}`
const location = formatLocationWithContext(
filePath,
start.line + 1,
start.character + 1,
include_context,
contextOptions
);
if (include_context) {
allCalls.push(
`• ${call.to.name} (${lspClient.symbolKindToString(call.to.kind)})\n ${location.replace(/\n/g, '\n ')}`
);
} else {
allCalls.push(
`• ${call.to.name} (${lspClient.symbolKindToString(call.to.kind)}) at ${location}`
);
}
}
}

Expand All @@ -1143,7 +1297,7 @@ server.setRequestHandler(CallToolRequestSchema, async (request) => {
content: [
{
type: 'text',
text: `Found ${allCalls.length} outgoing call(s):\n\n${allCalls.join('\n')}`,
text: `Found ${allCalls.length} outgoing call(s):\n\n${allCalls.join(include_context ? '\n\n' : '\n')}`,
},
],
};
Expand Down
Loading