File size: 18,371 Bytes
84aa3bf | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 | /**
* @license
* Copyright 2025 Google LLC
* SPDX-License-Identifier: Apache-2.0
*/
import { McpPromptLoader } from './McpPromptLoader.js';
import type { Config } from '@google/gemini-cli-core';
import type { PromptArgument } from '@modelcontextprotocol/sdk/types.js';
import { describe, it, expect, vi, beforeEach } from 'vitest';
import { CommandKind, type CommandContext } from '../ui/commands/types.js';
import * as cliCore from '@google/gemini-cli-core';
// Define the mock prompt data at a higher scope
const mockPrompt = {
name: 'test-prompt',
description: 'A test prompt.',
serverName: 'test-server',
arguments: [
{ name: 'name', required: true, description: "The animal's name." },
{ name: 'age', required: true, description: "The animal's age." },
{ name: 'species', required: true, description: "The animal's species." },
{
name: 'enclosure',
required: false,
description: "The animal's enclosure.",
},
{ name: 'trail', required: false, description: "The animal's trail." },
],
invoke: vi.fn().mockResolvedValue({
messages: [{ content: { type: 'text', text: 'Hello, world!' } }],
}),
};
describe('McpPromptLoader', () => {
const mockConfig = {} as Config;
// Use a beforeEach to set up and clean a spy for each test
beforeEach(() => {
vi.clearAllMocks();
vi.spyOn(cliCore, 'getMCPServerPrompts').mockReturnValue([mockPrompt]);
});
// --- `parseArgs` tests remain the same ---
describe('parseArgs', () => {
it('should handle multi-word positional arguments', () => {
const loader = new McpPromptLoader(mockConfig);
const promptArgs: PromptArgument[] = [
{ name: 'arg1', required: true },
{ name: 'arg2', required: true },
];
const userArgs = 'hello world';
const result = loader.parseArgs(userArgs, promptArgs);
expect(result).toEqual({ arg1: 'hello', arg2: 'world' });
});
it('should handle quoted multi-word positional arguments', () => {
const loader = new McpPromptLoader(mockConfig);
const promptArgs: PromptArgument[] = [
{ name: 'arg1', required: true },
{ name: 'arg2', required: true },
];
const userArgs = '"hello world" foo';
const result = loader.parseArgs(userArgs, promptArgs);
expect(result).toEqual({ arg1: 'hello world', arg2: 'foo' });
});
it('should handle a single positional argument with multiple words', () => {
const loader = new McpPromptLoader(mockConfig);
const promptArgs: PromptArgument[] = [{ name: 'arg1', required: true }];
const userArgs = 'hello world';
const result = loader.parseArgs(userArgs, promptArgs);
expect(result).toEqual({ arg1: 'hello world' });
});
it('should handle escaped quotes in positional arguments', () => {
const loader = new McpPromptLoader(mockConfig);
const promptArgs: PromptArgument[] = [{ name: 'arg1', required: true }];
const userArgs = '"hello \\"world\\""';
const result = loader.parseArgs(userArgs, promptArgs);
expect(result).toEqual({ arg1: 'hello "world"' });
});
it('should handle escaped backslashes in positional arguments', () => {
const loader = new McpPromptLoader(mockConfig);
const promptArgs: PromptArgument[] = [{ name: 'arg1', required: true }];
const userArgs = '"hello\\\\world"';
const result = loader.parseArgs(userArgs, promptArgs);
expect(result).toEqual({ arg1: 'hello\\world' });
});
it('should handle named args followed by positional args', () => {
const loader = new McpPromptLoader(mockConfig);
const promptArgs: PromptArgument[] = [
{ name: 'named', required: true },
{ name: 'pos', required: true },
];
const userArgs = '--named="value" positional';
const result = loader.parseArgs(userArgs, promptArgs);
expect(result).toEqual({ named: 'value', pos: 'positional' });
});
it('should handle positional args followed by named args', () => {
const loader = new McpPromptLoader(mockConfig);
const promptArgs: PromptArgument[] = [
{ name: 'pos', required: true },
{ name: 'named', required: true },
];
const userArgs = 'positional --named="value"';
const result = loader.parseArgs(userArgs, promptArgs);
expect(result).toEqual({ pos: 'positional', named: 'value' });
});
it('should handle positional args interspersed with named args', () => {
const loader = new McpPromptLoader(mockConfig);
const promptArgs: PromptArgument[] = [
{ name: 'pos1', required: true },
{ name: 'named', required: true },
{ name: 'pos2', required: true },
];
const userArgs = 'p1 --named="value" p2';
const result = loader.parseArgs(userArgs, promptArgs);
expect(result).toEqual({ pos1: 'p1', named: 'value', pos2: 'p2' });
});
it('should treat an escaped quote at the start as a literal', () => {
const loader = new McpPromptLoader(mockConfig);
const promptArgs: PromptArgument[] = [
{ name: 'arg1', required: true },
{ name: 'arg2', required: true },
];
const userArgs = '\\"hello world';
const result = loader.parseArgs(userArgs, promptArgs);
expect(result).toEqual({ arg1: '"hello', arg2: 'world' });
});
it('should handle a complex mix of args', () => {
const loader = new McpPromptLoader(mockConfig);
const promptArgs: PromptArgument[] = [
{ name: 'pos1', required: true },
{ name: 'named1', required: true },
{ name: 'pos2', required: true },
{ name: 'named2', required: true },
{ name: 'pos3', required: true },
];
const userArgs =
'p1 --named1="value 1" "p2 has spaces" --named2=value2 "p3 \\"with quotes\\""';
const result = loader.parseArgs(userArgs, promptArgs);
expect(result).toEqual({
pos1: 'p1',
named1: 'value 1',
pos2: 'p2 has spaces',
named2: 'value2',
pos3: 'p3 "with quotes"',
});
});
});
describe('loadCommands', () => {
const mockConfigWithPrompts = {
getMcpClientManager: () => ({
getMcpServers: () => ({
'test-server': { httpUrl: 'https://test-server.com' },
}),
}),
} as unknown as Config;
it('should load prompts as slash commands', async () => {
const loader = new McpPromptLoader(mockConfigWithPrompts);
const commands = await loader.loadCommands(new AbortController().signal);
expect(commands).toHaveLength(1);
expect(commands[0].name).toBe('test-prompt');
expect(commands[0].description).toBe('A test prompt.');
expect(commands[0].kind).toBe(CommandKind.MCP_PROMPT);
});
it('should sanitize prompt names by replacing spaces with hyphens', async () => {
const mockPromptWithSpaces = {
...mockPrompt,
name: 'Prompt Name',
};
vi.spyOn(cliCore, 'getMCPServerPrompts').mockReturnValue([
mockPromptWithSpaces,
]);
const loader = new McpPromptLoader(mockConfigWithPrompts);
const commands = await loader.loadCommands(new AbortController().signal);
expect(commands).toHaveLength(1);
expect(commands[0].name).toBe('Prompt-Name');
expect(commands[0].kind).toBe(CommandKind.MCP_PROMPT);
});
it('should trim whitespace from prompt names before sanitizing', async () => {
const mockPromptWithWhitespace = {
...mockPrompt,
name: ' Prompt Name ',
};
vi.spyOn(cliCore, 'getMCPServerPrompts').mockReturnValue([
mockPromptWithWhitespace,
]);
const loader = new McpPromptLoader(mockConfigWithPrompts);
const commands = await loader.loadCommands(new AbortController().signal);
expect(commands).toHaveLength(1);
expect(commands[0].name).toBe('Prompt-Name');
expect(commands[0].kind).toBe(CommandKind.MCP_PROMPT);
});
it('should handle prompt invocation successfully', async () => {
const loader = new McpPromptLoader(mockConfigWithPrompts);
const commands = await loader.loadCommands(new AbortController().signal);
const action = commands[0].action!;
const context = {} as CommandContext;
const result = await action(context, 'test-name 123 tiger');
expect(mockPrompt.invoke).toHaveBeenCalledWith({
name: 'test-name',
age: '123',
species: 'tiger',
});
expect(result).toEqual({
type: 'submit_prompt',
content: JSON.stringify('Hello, world!'),
});
});
it('should return an error for missing required arguments', async () => {
const loader = new McpPromptLoader(mockConfigWithPrompts);
const commands = await loader.loadCommands(new AbortController().signal);
const action = commands[0].action!;
const context = {} as CommandContext;
const result = await action(context, 'test-name');
expect(result).toEqual({
type: 'message',
messageType: 'error',
content: 'Missing required argument(s): --age, --species',
});
});
it('should return an error message if prompt invocation fails', async () => {
vi.spyOn(mockPrompt, 'invoke').mockRejectedValue(
new Error('Invocation failed!'),
);
const loader = new McpPromptLoader(mockConfigWithPrompts);
const commands = await loader.loadCommands(new AbortController().signal);
const action = commands[0].action!;
const context = {} as CommandContext;
const result = await action(context, 'test-name 123 tiger');
expect(result).toEqual({
type: 'message',
messageType: 'error',
content: 'Error: Invocation failed!',
});
});
it('should return an empty array if config is not available', async () => {
const loader = new McpPromptLoader(null);
const commands = await loader.loadCommands(new AbortController().signal);
expect(commands).toEqual([]);
});
describe('autoExecute', () => {
it('should set autoExecute to true for prompts with no arguments (undefined)', async () => {
vi.spyOn(cliCore, 'getMCPServerPrompts').mockReturnValue([
{ ...mockPrompt, arguments: undefined },
]);
const loader = new McpPromptLoader(mockConfigWithPrompts);
const commands = await loader.loadCommands(
new AbortController().signal,
);
expect(commands[0].autoExecute).toBe(true);
});
it('should set autoExecute to true for prompts with empty arguments array', async () => {
vi.spyOn(cliCore, 'getMCPServerPrompts').mockReturnValue([
{ ...mockPrompt, arguments: [] },
]);
const loader = new McpPromptLoader(mockConfigWithPrompts);
const commands = await loader.loadCommands(
new AbortController().signal,
);
expect(commands[0].autoExecute).toBe(true);
});
it('should set autoExecute to false for prompts with only optional arguments', async () => {
vi.spyOn(cliCore, 'getMCPServerPrompts').mockReturnValue([
{
...mockPrompt,
arguments: [{ name: 'optional', required: false }],
},
]);
const loader = new McpPromptLoader(mockConfigWithPrompts);
const commands = await loader.loadCommands(
new AbortController().signal,
);
expect(commands[0].autoExecute).toBe(false);
});
it('should set autoExecute to false for prompts with required arguments', async () => {
vi.spyOn(cliCore, 'getMCPServerPrompts').mockReturnValue([
{
...mockPrompt,
arguments: [{ name: 'required', required: true }],
},
]);
const loader = new McpPromptLoader(mockConfigWithPrompts);
const commands = await loader.loadCommands(
new AbortController().signal,
);
expect(commands[0].autoExecute).toBe(false);
});
});
describe('completion', () => {
it('should suggest no arguments when using positional arguments', async () => {
const loader = new McpPromptLoader(mockConfigWithPrompts);
const commands = await loader.loadCommands(
new AbortController().signal,
);
const completion = commands[0].completion!;
const context = {} as CommandContext;
const suggestions = await completion(context, 'test-name 6 tiger');
expect(suggestions).toEqual([]);
});
it('should suggest all arguments when none are present', async () => {
const loader = new McpPromptLoader(mockConfigWithPrompts);
const commands = await loader.loadCommands(
new AbortController().signal,
);
const completion = commands[0].completion!;
const context = {
invocation: {
raw: '/find ',
name: 'find',
args: '',
},
} as CommandContext;
const suggestions = await completion(context, '');
expect(suggestions).toEqual([
'--name="',
'--age="',
'--species="',
'--enclosure="',
'--trail="',
]);
});
it('should suggest remaining arguments when some are present', async () => {
const loader = new McpPromptLoader(mockConfigWithPrompts);
const commands = await loader.loadCommands(
new AbortController().signal,
);
const completion = commands[0].completion!;
const context = {
invocation: {
raw: '/find --name="test-name" --age="6" ',
name: 'find',
args: '--name="test-name" --age="6"',
},
} as CommandContext;
const suggestions = await completion(context, '');
expect(suggestions).toEqual([
'--species="',
'--enclosure="',
'--trail="',
]);
});
it('should suggest no arguments when all are present', async () => {
const loader = new McpPromptLoader(mockConfigWithPrompts);
const commands = await loader.loadCommands(
new AbortController().signal,
);
const completion = commands[0].completion!;
const context = {} as CommandContext;
const suggestions = await completion(
context,
'--name="test-name" --age="6" --species="tiger" --enclosure="Tiger Den" --trail="Jungle"',
);
expect(suggestions).toEqual([]);
});
it('should suggest nothing for prompts with no arguments', async () => {
// Temporarily override the mock to return a prompt with no args
vi.spyOn(cliCore, 'getMCPServerPrompts').mockReturnValue([
{ ...mockPrompt, arguments: [] },
]);
const loader = new McpPromptLoader(mockConfigWithPrompts);
const commands = await loader.loadCommands(
new AbortController().signal,
);
const completion = commands[0].completion!;
const context = {} as CommandContext;
const suggestions = await completion(context, '');
expect(suggestions).toEqual([]);
});
it('should suggest arguments matching a partial argument', async () => {
const loader = new McpPromptLoader(mockConfigWithPrompts);
const commands = await loader.loadCommands(
new AbortController().signal,
);
const completion = commands[0].completion!;
const context = {
invocation: {
raw: '/find --s',
name: 'find',
args: '--s',
},
} as CommandContext;
const suggestions = await completion(context, '--s');
expect(suggestions).toEqual(['--species="']);
});
it('should suggest arguments even when a partial argument is parsed as a value', async () => {
const loader = new McpPromptLoader(mockConfigWithPrompts);
const commands = await loader.loadCommands(
new AbortController().signal,
);
const completion = commands[0].completion!;
const context = {
invocation: {
raw: '/find --name="test" --a',
name: 'find',
args: '--name="test" --a',
},
} as CommandContext;
const suggestions = await completion(context, '--a');
expect(suggestions).toEqual(['--age="']);
});
it('should auto-close the quote for a named argument value', async () => {
const loader = new McpPromptLoader(mockConfigWithPrompts);
const commands = await loader.loadCommands(
new AbortController().signal,
);
const completion = commands[0].completion!;
const context = {
invocation: {
raw: '/find --name="test',
name: 'find',
args: '--name="test',
},
} as CommandContext;
const suggestions = await completion(context, '--name="test');
expect(suggestions).toEqual(['--name="test"']);
});
it('should auto-close the quote for an empty named argument value', async () => {
const loader = new McpPromptLoader(mockConfigWithPrompts);
const commands = await loader.loadCommands(
new AbortController().signal,
);
const completion = commands[0].completion!;
const context = {
invocation: {
raw: '/find --name="',
name: 'find',
args: '--name="',
},
} as CommandContext;
const suggestions = await completion(context, '--name="');
expect(suggestions).toEqual(['--name=""']);
});
it('should not add a quote if already present', async () => {
const loader = new McpPromptLoader(mockConfigWithPrompts);
const commands = await loader.loadCommands(
new AbortController().signal,
);
const completion = commands[0].completion!;
const context = {
invocation: {
raw: '/find --name="test"',
name: 'find',
args: '--name="test"',
},
} as CommandContext;
const suggestions = await completion(context, '--name="test"');
expect(suggestions).toEqual([]);
});
});
});
});
|