mirror of
https://github.com/abhigyanpatwari/GitNexus.git
synced 2026-09-06 08:16:02 +00:00
* feat(mcp): add tool safety annotations * test(mcp): address PR #1127 review follow-ups - Replace private `_requestHandlers` SDK access in server.test.ts with `Client` + `InMemoryTransport.createLinkedPair()` for the tools/list annotation propagation test. The new path uses supported public APIs and surfaces SDK changes loudly instead of silently degrading. - Extract `OPEN_WORLD_READ_ONLY_TOOLS` set in tools.test.ts so future read-only open-world tools can be added without rewriting the invariant; preserves the current "only `query` is open-world" guard. - Add inline rationale on `group_sync` annotations explaining the conservative `idempotentHint: false` (writes contracts.json on every call even when output is deterministic). No runtime behavior change. Annotations themselves and tools/list shape are unchanged. --------- Co-authored-by: Gergo Magyar <gergomagyar@icloud.com>
203 lines
8.1 KiB
TypeScript
203 lines
8.1 KiB
TypeScript
/**
|
|
* Unit Tests: MCP Tool Definitions
|
|
*
|
|
* Tests: GITNEXUS_TOOLS from tools.ts
|
|
* - All 13 tools are defined (per-repo + group_list/group_sync)
|
|
* - Each tool has valid name, description, inputSchema
|
|
* - Required fields are correct
|
|
* - Optional repo parameter is present on tools that need it
|
|
*/
|
|
import { describe, it, expect } from 'vitest';
|
|
import { GITNEXUS_TOOLS } from '../../src/mcp/tools.js';
|
|
|
|
const GROUP_TOOLS = new Set(['group_list', 'group_sync']);
|
|
const MUTATING_TOOLS = new Set(['rename', 'group_sync']);
|
|
// Read-only tools that legitimately reach external systems. Add a tool name
|
|
// here when introducing a read-only tool that needs openWorldHint: true.
|
|
const OPEN_WORLD_READ_ONLY_TOOLS = new Set(['query']);
|
|
|
|
describe('GITNEXUS_TOOLS', () => {
|
|
it('exports all tools (7 base + 3 route/tool/shape + 1 api_impact + 2 group)', () => {
|
|
expect(GITNEXUS_TOOLS).toHaveLength(13);
|
|
});
|
|
|
|
it('contains all expected tool names', () => {
|
|
const names = GITNEXUS_TOOLS.map((t) => t.name);
|
|
expect(names).toEqual(
|
|
expect.arrayContaining([
|
|
'list_repos',
|
|
'query',
|
|
'cypher',
|
|
'context',
|
|
'detect_changes',
|
|
'rename',
|
|
'impact',
|
|
'api_impact',
|
|
]),
|
|
);
|
|
});
|
|
|
|
it('each tool has name, description, and inputSchema', () => {
|
|
for (const tool of GITNEXUS_TOOLS) {
|
|
expect(tool.name).toBeTruthy();
|
|
expect(typeof tool.name).toBe('string');
|
|
expect(tool.description).toBeTruthy();
|
|
expect(typeof tool.description).toBe('string');
|
|
expect(tool.annotations).toBeDefined();
|
|
expect(tool.inputSchema).toBeDefined();
|
|
expect(tool.inputSchema.type).toBe('object');
|
|
expect(tool.inputSchema.properties).toBeDefined();
|
|
expect(Array.isArray(tool.inputSchema.required)).toBe(true);
|
|
}
|
|
});
|
|
|
|
it('each tool exposes all MCP safety annotations', () => {
|
|
for (const tool of GITNEXUS_TOOLS) {
|
|
expect(typeof tool.annotations.readOnlyHint).toBe('boolean');
|
|
expect(typeof tool.annotations.destructiveHint).toBe('boolean');
|
|
expect(typeof tool.annotations.idempotentHint).toBe('boolean');
|
|
expect(typeof tool.annotations.openWorldHint).toBe('boolean');
|
|
}
|
|
});
|
|
|
|
it('read-only tools are marked non-destructive and idempotent', () => {
|
|
for (const tool of GITNEXUS_TOOLS) {
|
|
if (MUTATING_TOOLS.has(tool.name)) continue;
|
|
|
|
expect(tool.annotations.readOnlyHint).toBe(true);
|
|
expect(tool.annotations.destructiveHint).toBe(false);
|
|
expect(tool.annotations.idempotentHint).toBe(true);
|
|
expect(tool.annotations.openWorldHint).toBe(OPEN_WORLD_READ_ONLY_TOOLS.has(tool.name));
|
|
}
|
|
});
|
|
|
|
it('query is marked open-world because it may use external embeddings', () => {
|
|
const queryTool = GITNEXUS_TOOLS.find((t) => t.name === 'query')!;
|
|
expect(queryTool.annotations).toEqual({
|
|
readOnlyHint: true,
|
|
destructiveHint: false,
|
|
idempotentHint: true,
|
|
openWorldHint: true,
|
|
});
|
|
});
|
|
|
|
it('rename and group_sync are marked mutating and non-idempotent', () => {
|
|
for (const name of ['rename', 'group_sync'] as const) {
|
|
const tool = GITNEXUS_TOOLS.find((t) => t.name === name)!;
|
|
expect(tool.annotations).toEqual({
|
|
readOnlyHint: false,
|
|
destructiveHint: true,
|
|
idempotentHint: false,
|
|
openWorldHint: false,
|
|
});
|
|
}
|
|
});
|
|
|
|
it('query tool requires "query" parameter', () => {
|
|
const queryTool = GITNEXUS_TOOLS.find((t) => t.name === 'query')!;
|
|
expect(queryTool.inputSchema.required).toContain('query');
|
|
expect(queryTool.inputSchema.properties.query).toBeDefined();
|
|
expect(queryTool.inputSchema.properties.query.type).toBe('string');
|
|
});
|
|
|
|
it('cypher tool requires "query" parameter', () => {
|
|
const cypherTool = GITNEXUS_TOOLS.find((t) => t.name === 'cypher')!;
|
|
expect(cypherTool.inputSchema.required).toContain('query');
|
|
});
|
|
|
|
it('context tool has no required parameters', () => {
|
|
const contextTool = GITNEXUS_TOOLS.find((t) => t.name === 'context')!;
|
|
expect(contextTool.inputSchema.required).toEqual([]);
|
|
});
|
|
|
|
it('impact tool requires target and direction', () => {
|
|
const impactTool = GITNEXUS_TOOLS.find((t) => t.name === 'impact')!;
|
|
expect(impactTool.inputSchema.required).toContain('target');
|
|
expect(impactTool.inputSchema.required).toContain('direction');
|
|
});
|
|
|
|
it('rename tool requires new_name', () => {
|
|
const renameTool = GITNEXUS_TOOLS.find((t) => t.name === 'rename')!;
|
|
expect(renameTool.inputSchema.required).toContain('new_name');
|
|
});
|
|
|
|
it('detect_changes tool has no required parameters', () => {
|
|
const detectTool = GITNEXUS_TOOLS.find((t) => t.name === 'detect_changes')!;
|
|
expect(detectTool.inputSchema.required).toEqual([]);
|
|
});
|
|
|
|
it('list_repos tool has no parameters', () => {
|
|
const listTool = GITNEXUS_TOOLS.find((t) => t.name === 'list_repos')!;
|
|
expect(Object.keys(listTool.inputSchema.properties)).toHaveLength(0);
|
|
expect(listTool.inputSchema.required).toEqual([]);
|
|
});
|
|
|
|
it('per-repo tools have optional repo parameter for backend selection', () => {
|
|
for (const tool of GITNEXUS_TOOLS) {
|
|
if (tool.name === 'list_repos') continue;
|
|
if (GROUP_TOOLS.has(tool.name)) continue;
|
|
expect(tool.inputSchema.properties.repo).toBeDefined();
|
|
expect(tool.inputSchema.properties.repo.type).toBe('string');
|
|
expect(tool.inputSchema.required).not.toContain('repo');
|
|
}
|
|
});
|
|
|
|
it('group tools without backend repo param omit repo property', () => {
|
|
for (const name of ['group_list', 'group_sync'] as const) {
|
|
const tool = GITNEXUS_TOOLS.find((t) => t.name === name)!;
|
|
expect(tool.inputSchema.properties).not.toHaveProperty('repo');
|
|
}
|
|
});
|
|
|
|
it('impact, query, and context expose optional service with minLength', () => {
|
|
for (const n of ['impact', 'query', 'context'] as const) {
|
|
const tool = GITNEXUS_TOOLS.find((t) => t.name === n)!;
|
|
const svc = tool.inputSchema.properties.service;
|
|
expect(svc, n).toBeDefined();
|
|
expect(svc!.minLength).toBe(1);
|
|
}
|
|
});
|
|
|
|
it('impact schema bounds match cross-impact validation ranges', () => {
|
|
const impact = GITNEXUS_TOOLS.find((t) => t.name === 'impact')!;
|
|
expect(impact.inputSchema.properties.maxDepth.minimum).toBe(1);
|
|
expect(impact.inputSchema.properties.maxDepth.maximum).toBe(32);
|
|
expect(impact.inputSchema.properties.minConfidence.minimum).toBe(0);
|
|
expect(impact.inputSchema.properties.minConfidence.maximum).toBe(1);
|
|
expect(impact.inputSchema.properties.timeoutMs.maximum).toBe(3600000);
|
|
});
|
|
|
|
it('detect_changes scope has correct enum values', () => {
|
|
const detectTool = GITNEXUS_TOOLS.find((t) => t.name === 'detect_changes')!;
|
|
const scopeProp = detectTool.inputSchema.properties.scope;
|
|
expect(scopeProp.enum).toEqual(['unstaged', 'staged', 'all', 'compare']);
|
|
});
|
|
|
|
it('api_impact tool has no required parameters', () => {
|
|
const apiImpactTool = GITNEXUS_TOOLS.find((t) => t.name === 'api_impact')!;
|
|
expect(apiImpactTool).toBeDefined();
|
|
expect(apiImpactTool.inputSchema.required).toEqual([]);
|
|
expect(apiImpactTool.inputSchema.properties.route).toBeDefined();
|
|
expect(apiImpactTool.inputSchema.properties.file).toBeDefined();
|
|
expect(apiImpactTool.inputSchema.properties.repo).toBeDefined();
|
|
});
|
|
|
|
it('impact relationTypes is array of strings', () => {
|
|
const impactTool = GITNEXUS_TOOLS.find((t) => t.name === 'impact')!;
|
|
const relProp = impactTool.inputSchema.properties.relationTypes;
|
|
expect(relProp.type).toBe('array');
|
|
expect(relProp.items).toEqual({ type: 'string' });
|
|
});
|
|
|
|
it('route_map description defers to api_impact for pre-change analysis', () => {
|
|
const routeMapTool = GITNEXUS_TOOLS.find((t) => t.name === 'route_map')!;
|
|
expect(routeMapTool.description).toContain('api_impact');
|
|
expect(routeMapTool.description).toContain('pre-change analysis');
|
|
});
|
|
|
|
it('shape_check description defers to api_impact for pre-change analysis', () => {
|
|
const shapeCheckTool = GITNEXUS_TOOLS.find((t) => t.name === 'shape_check')!;
|
|
expect(shapeCheckTool.description).toContain('api_impact');
|
|
expect(shapeCheckTool.description).toContain('pre-change analysis');
|
|
});
|
|
});
|