Files
TREK/server/tests/unit/nest-mcp/helpers.test.ts
T
Maurice 7283b75cac feat(mcp): list_collection_places pages a long list compactly (#2647)
A read tool that answers one list a page at a time (100 by default, up to
500) as compact one-line JSON rows, filtered by status, label or "no label",
with the list's labels, the matching total and a cursor. The cursor is the
last place's position (sort_order, created_at, id), so labelling a page
while paging through unlabelled places skips none. getCollection orders by
the same keys, id last, so both tools agree on ties.
2026-11-13 10:17:11 +01:00

80 lines
2.4 KiB
TypeScript

import {
demoDenied,
errorResult,
ok,
okCompact,
TOOL_ANNOTATIONS_DELETE,
TOOL_ANNOTATIONS_NON_IDEMPOTENT,
TOOL_ANNOTATIONS_OPEN_WORLD_NON_IDEMPOTENT,
TOOL_ANNOTATIONS_OPEN_WORLD_READONLY,
TOOL_ANNOTATIONS_READONLY,
TOOL_ANNOTATIONS_WRITE,
} from '../../../src/nest-mcp';
import { describe, expect, it } from 'vitest';
describe('result helpers', () => {
it('ok() wraps data as one pretty-printed JSON text block, without isError', () => {
const result = ok({ a: 1 });
expect(result).toEqual({ content: [{ type: 'text', text: JSON.stringify({ a: 1 }, null, 2) }] });
expect('isError' in result).toBe(false);
});
it('okCompact() wraps data as one line of JSON, without isError', () => {
const result = okCompact({ a: 1, b: [2, 3] });
expect(result).toEqual({ content: [{ type: 'text', text: '{"a":1,"b":[2,3]}' }] });
expect('isError' in result).toBe(false);
});
it('errorResult() carries the message verbatim with isError', () => {
expect(errorResult('Tag not found.')).toEqual({
content: [{ type: 'text', text: 'Tag not found.' }],
isError: true,
});
});
it('demoDenied() uses the canned demo-mode message', () => {
expect(demoDenied()).toEqual({
content: [{ type: 'text', text: 'Write operations are disabled in demo mode.' }],
isError: true,
});
});
});
describe('tool annotation presets', () => {
it('encode the read/write/delete/idempotency matrix', () => {
expect(TOOL_ANNOTATIONS_READONLY).toEqual({
readOnlyHint: true,
destructiveHint: false,
idempotentHint: true,
openWorldHint: false,
});
expect(TOOL_ANNOTATIONS_WRITE).toEqual({
readOnlyHint: false,
destructiveHint: false,
idempotentHint: true,
openWorldHint: false,
});
expect(TOOL_ANNOTATIONS_DELETE).toEqual({
readOnlyHint: false,
destructiveHint: true,
idempotentHint: true,
openWorldHint: false,
});
expect(TOOL_ANNOTATIONS_NON_IDEMPOTENT).toEqual({
readOnlyHint: false,
destructiveHint: false,
idempotentHint: false,
openWorldHint: false,
});
});
it('open-world variants only flip openWorldHint', () => {
expect(TOOL_ANNOTATIONS_OPEN_WORLD_READONLY).toEqual({ ...TOOL_ANNOTATIONS_READONLY, openWorldHint: true });
expect(TOOL_ANNOTATIONS_OPEN_WORLD_NON_IDEMPOTENT).toEqual({
...TOOL_ANNOTATIONS_NON_IDEMPOTENT,
openWorldHint: true,
});
});
});