gsadmin/AutopilotMonitor
1
0
Fork 0
mirror of https://github.com/okieselbach/AutopilotMonitor.git synced 2026-10-24 12:42:38 +00:00
Code Issues Packages Projects Releases Wiki Activity

feat(mcp): resolve tenants by name or id directly in list_tenants

Browse Source 
list_tenants gains two optional filter params so the model resolves a
tenant in ONE tool call instead of paging manually:

- query: case-insensitive substring match on domainName (and tenantId
  for pasted partial GUIDs), e.g. query="rewe" -> rewe-group.com
- tenantId: exact case-insensitive point lookup; wins over query

In filter mode the tool auto-paginates /api/config/all internally
(pageSize 1000, 10-page runaway budget -> `truncated` + recallNote if
ever hit) and returns only the matches. Filtering runs AFTER
extractTenantList secret-stripping and delegatedTenantListView MSP
scoping, so it can only narrow — never widen — what the caller may see.

Pure filterTenantList helper exported + 7 unit tests.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This commit is contained in:
Oliver Kieselbach
2026-07-16 16:36:24 +02:00
parent d02fa454a7
commit 3ebeb644eb
2 changed files with 160 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/McpServer/autopilot-monitor-mcp/src/__tests__/security-guards.test.ts
+49 -1
View File
@@ -20,7 +20,7 @@ import { followNextLink } from '../client.js';
import { SessionIdSchema } from '../tools/shared.js';
import { ApiError } from '../client.js';
import { toolError } from '../tools/error-handler.js';
import { extractTenantList, TENANT_SAFE_FIELDS } from '../tools/admin.js';
import { extractTenantList, filterTenantList, TENANT_SAFE_FIELDS } from '../tools/admin.js';
// Importing the OAuth helper requires the env var that gates module load.
// Set a dummy value before the import resolves so the throw doesn't fire.
@@ -596,6 +596,54 @@ describe('list_tenants — extractTenantList keep-list projection', () => {
});
});
describe('list_tenants — filterTenantList (query / tenantId resolution)', () => {
const tenants = [
{ tenantId: '047b2e1f-a271-4bc1-97a4-703bf7adf135', domainName: 'rewe-group.com' },
{ tenantId: '739614a3-9800-4868-ba08-7e2c16128a9f', domainName: 'HanseMerkur.onmicrosoft.com' },
{ tenantId: '661d1080-0353-4416-a568-f85f2d4f2ff5', domainName: 'douglas.de' },
];
it('returns the list unchanged for a blank / whitespace filter', () => {
expect(filterTenantList(tenants, {})).toBe(tenants);
expect(filterTenantList(tenants, { query: ' ' })).toBe(tenants);
expect(filterTenantList(tenants, { tenantId: ' ' })).toBe(tenants);
});
it('resolves a name to its tenant via case-insensitive domainName substring', () => {
const [m] = filterTenantList(tenants, { query: 'REWE' });
expect(m.domainName).toBe('rewe-group.com');
expect(m.tenantId).toBe('047b2e1f-a271-4bc1-97a4-703bf7adf135');
expect(filterTenantList(tenants, { query: 'merkur' })).toHaveLength(1);
});
it('matches a substring anywhere in the domainName, not just a prefix', () => {
expect(filterTenantList(tenants, { query: 'group' })[0].domainName).toBe('rewe-group.com');
});
it('also matches against a partial tenantId (forgiving GUID paste)', () => {
expect(filterTenantList(tenants, { query: '739614a3' })[0].domainName)
.toBe('HanseMerkur.onmicrosoft.com');
});
it('tenantId filter is an exact case-insensitive match and wins over query', () => {
const exact = filterTenantList(tenants, {
tenantId: '661D1080-0353-4416-A568-F85F2D4F2FF5',
query: 'rewe',
});
expect(exact).toHaveLength(1);
expect(exact[0].domainName).toBe('douglas.de');
});
it('returns an empty list when nothing matches (no throw)', () => {
expect(filterTenantList(tenants, { query: 'contoso' })).toEqual([]);
expect(filterTenantList(tenants, { tenantId: 'no-such-id' })).toEqual([]);
});
it('tolerates rows missing domainName / tenantId', () => {
expect(filterTenantList([{ tenantId: 'x' }, {}], { query: 'rewe' })).toEqual([]);
});
});
// ---------------------------------------------------------------------------
// 2026-06-30 security review fixes (M1 / M2 / M3)
// ---------------------------------------------------------------------------
src/McpServer/autopilot-monitor-mcp/src/tools/admin.ts
+111 -10
View File
@@ -41,6 +41,42 @@ export function extractTenantList(data: unknown): Record<string, unknown>[] {
});
}
/**
* In-tool filtering for list_tenants. Applied AFTER extractTenantList (and, for a
* delegated caller, AFTER delegatedTenantListView) so it can never widen the
* security boundary — it only removes rows the caller was already allowed to see.
*
* Precedence: an exact `tenantId` wins (case-insensitive equality); otherwise a
* `query` is a case-insensitive substring match against `domainName` — the only
* human-readable label in TENANT_SAFE_FIELDS (there is no displayName) — and,
* forgivingly, against `tenantId` too so a pasted partial GUID resolves. Whitespace
* is trimmed; a blank filter is a no-op (returns the list unchanged). Pure + testable.
*/
export function filterTenantList(
tenants: Record<string, unknown>[],
filter: { tenantId?: string; query?: string },
): Record<string, unknown>[] {
const tid = filter.tenantId?.trim().toLowerCase();
if (tid) {
return tenants.filter((t) => String(t.tenantId ?? '').toLowerCase() === tid);
}
const q = filter.query?.trim().toLowerCase();
if (!q) return tenants;
return tenants.filter((t) =>
String(t.domainName ?? '').toLowerCase().includes(q)
|| String(t.tenantId ?? '').toLowerCase().includes(q));
}
/**
* When list_tenants runs in filter mode it auto-paginates internally so the model
* gets its answer in ONE tool call. A large page size collapses the current tenant
* population (a few hundred) into a single backend round-trip; the page budget is a
* runaway guard, not an expected limit. If the budget is ever hit before the scan
* drains, the tool flags `truncated` rather than silently dropping matches.
*/
const TENANT_FILTER_PAGE_SIZE = 1000;
const TENANT_FILTER_MAX_PAGES = 10;
/**
* Delegated (MSP) view of the list_tenants result — the web analog is delegatedScopedTenantList in
* utils/homeTenantScope.ts. The backend already bounds config/all to the caller's managed subset
@@ -518,27 +554,92 @@ export function registerAdminTools(server: McpServer, ga: boolean, strictGa: boo
'server-side. Tenants are sorted by tenantId and returned in pages (default 100). For lean ID discovery pass ' +
'`fields=tenantId,domainName` — the projection is applied server-side and is echoed in nextLink, so it carries ' +
'across every page automatically. ' +
'Pagination: when "nextLink" is present, more tenants are available — call again and pass that whole string ' +
'back as "continuation". Stop when nextLink is absent.',
'RESOLVE A TENANT DIRECTLY (no manual paging): pass `query` to substring-match a name — e.g. query="rewe" ' +
'returns rewe-group.com with its tenantId in one call — or pass `tenantId` to fetch that exact entry. In either ' +
'filter mode the tool auto-paginates internally and returns only the matches (no "continuation" needed). ' +
'Pagination (only when NEITHER filter is set): when "nextLink" is present, more tenants are available — call ' +
'again and pass that whole string back as "continuation". Stop when nextLink is absent.',
inputSchema: {
query: z.string().optional()
.describe('Resolve a tenant by name: case-insensitive substring match against domainName (the human-readable ' +
'label — there is no separate displayName) and, forgivingly, against tenantId. e.g. "rewe" → rewe-group.com. ' +
'Auto-paginates internally and returns every match in one call. Ignored if tenantId is also set.'),
tenantId: z.string().optional()
.describe('Fetch exactly one tenant by its (case-insensitive) tenantId. Returns that single entry, or an empty ' +
'list if no such tenant exists. Takes precedence over query.'),
fields: z.string().optional()
.describe('Comma-separated subset of safe fields to return (e.g. "tenantId,domainName" for lean ID discovery). ' +
'tenantId is always included. Default: all safe fields. Applied server-side; unknown/secret keys are ignored.'),
pageSize: z.coerce.number().int().min(1).max(1000).optional().default(100)
.describe('Page size (1-1000, default 100). Tenants are sorted by tenantId; follow nextLink to fetch more.'),
.describe('Page size (1-1000, default 100) for the unfiltered listing. Ignored in filter mode (query/tenantId), ' +
'which scans with a large internal page size. Tenants are sorted by tenantId; follow nextLink to fetch more.'),
continuation: z.string().optional()
.describe('Either the opaque "continuation" value from a prior response or the full nextLink path — both are accepted; the latter is preferred so backend-echoed query params (pageSize, fields) round-trip correctly.'),
.describe('Either the opaque "continuation" value from a prior response or the full nextLink path — both are accepted; the latter is preferred so backend-echoed query params (pageSize, fields) round-trip correctly. Ignored in filter mode.'),
},
annotations: READ_ONLY,
},
async (args) => withToolTelemetry('list_tenants', async () => {
try {
const { fields, pageSize, continuation } = args;
// /api/config/all supports opt-in pagination: passing pageSize switches the
// backend from its legacy unpaginated bare array to a secret-stripped
// { count, tenants, nextLink } envelope, with fields= projected server-side
// and echoed in nextLink. extractTenantList re-applies the keep-list as
// defense-in-depth (harmless pass-through once the backend has projected).
const { query, tenantId, fields, pageSize, continuation } = args;
// Filter mode (query or tenantId): resolve a tenant to its id in ONE tool call
// instead of making the model page and eyeball. The tool exhausts /api/config/all
// itself with a large internal page size (the whole tenant population collapses to
// ~one backend round-trip), then filters in memory. Filtering runs AFTER the same
// extractTenantList (+ delegatedTenantListView) path the unfiltered listing uses, so
// it can only ever narrow what the caller was already entitled to see. A query needs
// domainName to match against, so ensure it survives an otherwise-narrow projection.
if (query || tenantId) {
const scanFields = (query && fields
&& !fields.split(',').map((f) => f.trim()).includes('domainName'))
? `${fields},domainName`
: fields;
const collected: Record<string, unknown>[] = [];
let nextLink: string | undefined;
let scannedPages = 0;
let truncated = false;
for (;;) {
const path = followNextLink(
'/api/config/all', { pageSize: TENANT_FILTER_PAGE_SIZE, fields: scanFields }, nextLink);
const data = await apiFetch(path) as { tenants?: unknown[]; nextLink?: string | null };
let pageTenants = extractTenantList({ tenants: data?.tenants ?? [] });
if (delegated) {
pageTenants = delegatedTenantListView(
pageTenants, getDelegatedTenantIds(), getHomeTenantId(), getCallerUpnDomain(),
scannedPages === 0);
}
collected.push(...pageTenants);
scannedPages++;
nextLink = typeof data?.nextLink === 'string' ? data.nextLink : undefined;
if (!nextLink) break;
if (scannedPages >= TENANT_FILTER_MAX_PAGES) { truncated = true; break; }
}
const matches = filterTenantList(collected, { tenantId, query });
return toolResultText(
{
count: matches.length,
tenants: matches,
nextLink: null,
scannedPages,
...(truncated
? {
truncated: true,
recallNote:
`Reached the ${scannedPages}-page scan budget before draining every tenant, so a ` +
'match on an unscanned page could be missing. Narrow the query or list without a filter.',
}
: {}),
},
MAX_RESULT_SIZE_CHARS.adminStream);
}
// Unfiltered listing. /api/config/all supports opt-in pagination: passing pageSize
// switches the backend from its legacy unpaginated bare array to a secret-stripped
// { count, tenants, nextLink } envelope, with fields= projected server-side and echoed
// in nextLink. extractTenantList re-applies the keep-list as defense-in-depth (harmless
// pass-through once the backend has projected).
const path = followNextLink('/api/config/all', { pageSize, fields }, continuation);
const data = await apiFetch(path) as { count?: number; tenants?: unknown[]; nextLink?: string | null };
let tenants = extractTenantList({ tenants: data?.tenants ?? [] });