options.ts•17 kB
import qs from 'qs';
import yargs from 'yargs';
import { hideBin } from 'yargs/helpers';
import z from 'zod';
import { endpoints, Filter } from './tools';
import { ClientCapabilities, knownClients, ClientType } from './compat';
export type CLIOptions = McpOptions & {
list: boolean;
transport: 'stdio' | 'http';
port: number | undefined;
socket: string | undefined;
};
export type McpOptions = {
client?: ClientType | undefined;
includeDynamicTools?: boolean | undefined;
includeAllTools?: boolean | undefined;
includeCodeTools?: boolean | undefined;
includeDocsTools?: boolean | undefined;
filters?: Filter[] | undefined;
capabilities?: Partial<ClientCapabilities> | undefined;
};
const CAPABILITY_CHOICES = [
'top-level-unions',
'valid-json',
'refs',
'unions',
'formats',
'tool-name-length',
] as const;
type Capability = (typeof CAPABILITY_CHOICES)[number];
function parseCapabilityValue(cap: string): { name: Capability; value?: number } {
if (cap.startsWith('tool-name-length=')) {
const parts = cap.split('=');
if (parts.length === 2) {
const length = parseInt(parts[1]!, 10);
if (!isNaN(length)) {
return { name: 'tool-name-length', value: length };
}
throw new Error(`Invalid tool-name-length value: ${parts[1]}. Expected a number.`);
}
throw new Error(`Invalid format for tool-name-length. Expected tool-name-length=N.`);
}
if (!CAPABILITY_CHOICES.includes(cap as Capability)) {
throw new Error(`Unknown capability: ${cap}. Valid capabilities are: ${CAPABILITY_CHOICES.join(', ')}`);
}
return { name: cap as Capability };
}
export function parseCLIOptions(): CLIOptions {
const opts = yargs(hideBin(process.argv))
.option('tools', {
type: 'string',
array: true,
choices: ['dynamic', 'all', 'code', 'docs'],
description: 'Use dynamic tools or all tools',
})
.option('no-tools', {
type: 'string',
array: true,
choices: ['dynamic', 'all', 'code', 'docs'],
description: 'Do not use any dynamic or all tools',
})
.option('tool', {
type: 'string',
array: true,
description: 'Include tools matching the specified names',
})
.option('resource', {
type: 'string',
array: true,
description: 'Include tools matching the specified resources',
})
.option('operation', {
type: 'string',
array: true,
choices: ['read', 'write'],
description: 'Include tools matching the specified operations',
})
.option('tag', {
type: 'string',
array: true,
description: 'Include tools with the specified tags',
})
.option('no-tool', {
type: 'string',
array: true,
description: 'Exclude tools matching the specified names',
})
.option('no-resource', {
type: 'string',
array: true,
description: 'Exclude tools matching the specified resources',
})
.option('no-operation', {
type: 'string',
array: true,
description: 'Exclude tools matching the specified operations',
})
.option('no-tag', {
type: 'string',
array: true,
description: 'Exclude tools with the specified tags',
})
.option('list', {
type: 'boolean',
description: 'List all tools and exit',
})
.option('client', {
type: 'string',
choices: Object.keys(knownClients),
description: 'Specify the MCP client being used',
})
.option('capability', {
type: 'string',
array: true,
description: 'Specify client capabilities',
coerce: (values: string[]) => {
return values.flatMap((v) => v.split(','));
},
})
.option('no-capability', {
type: 'string',
array: true,
description: 'Unset client capabilities',
choices: CAPABILITY_CHOICES,
coerce: (values: string[]) => {
return values.flatMap((v) => v.split(','));
},
})
.option('describe-capabilities', {
type: 'boolean',
description: 'Print detailed explanation of client capabilities and exit',
})
.option('transport', {
type: 'string',
choices: ['stdio', 'http'],
default: 'stdio',
description: 'What transport to use; stdio for local servers or http for remote servers',
})
.option('port', {
type: 'number',
description: 'Port to serve on if using http transport',
})
.option('socket', {
type: 'string',
description: 'Unix socket to serve on if using http transport',
})
.help();
for (const [command, desc] of examples()) {
opts.example(command, desc);
}
const argv = opts.parseSync();
// Handle describe-capabilities flag
if (argv.describeCapabilities) {
console.log(getCapabilitiesExplanation());
process.exit(0);
}
const filters: Filter[] = [];
// Helper function to support comma-separated values
const splitValues = (values: string[] | undefined): string[] => {
if (!values) return [];
return values.flatMap((v) => v.split(','));
};
for (const tag of splitValues(argv.tag)) {
filters.push({ type: 'tag', op: 'include', value: tag });
}
for (const tag of splitValues(argv.noTag)) {
filters.push({ type: 'tag', op: 'exclude', value: tag });
}
for (const resource of splitValues(argv.resource)) {
filters.push({ type: 'resource', op: 'include', value: resource });
}
for (const resource of splitValues(argv.noResource)) {
filters.push({ type: 'resource', op: 'exclude', value: resource });
}
for (const tool of splitValues(argv.tool)) {
filters.push({ type: 'tool', op: 'include', value: tool });
}
for (const tool of splitValues(argv.noTool)) {
filters.push({ type: 'tool', op: 'exclude', value: tool });
}
for (const operation of splitValues(argv.operation)) {
filters.push({ type: 'operation', op: 'include', value: operation });
}
for (const operation of splitValues(argv.noOperation)) {
filters.push({ type: 'operation', op: 'exclude', value: operation });
}
// Parse client capabilities
const clientCapabilities: Partial<ClientCapabilities> = {};
// Apply individual capability overrides
if (Array.isArray(argv.capability)) {
for (const cap of argv.capability) {
const parsedCap = parseCapabilityValue(cap);
if (parsedCap.name === 'top-level-unions') {
clientCapabilities.topLevelUnions = true;
} else if (parsedCap.name === 'valid-json') {
clientCapabilities.validJson = true;
} else if (parsedCap.name === 'refs') {
clientCapabilities.refs = true;
} else if (parsedCap.name === 'unions') {
clientCapabilities.unions = true;
} else if (parsedCap.name === 'formats') {
clientCapabilities.formats = true;
} else if (parsedCap.name === 'tool-name-length') {
clientCapabilities.toolNameLength = parsedCap.value;
}
}
}
// Handle no-capability options to unset capabilities
if (Array.isArray(argv.noCapability)) {
for (const cap of argv.noCapability) {
if (cap === 'top-level-unions') {
clientCapabilities.topLevelUnions = false;
} else if (cap === 'valid-json') {
clientCapabilities.validJson = false;
} else if (cap === 'refs') {
clientCapabilities.refs = false;
} else if (cap === 'unions') {
clientCapabilities.unions = false;
} else if (cap === 'formats') {
clientCapabilities.formats = false;
} else if (cap === 'tool-name-length') {
clientCapabilities.toolNameLength = undefined;
}
}
}
const shouldIncludeToolType = (toolType: 'dynamic' | 'all' | 'code' | 'docs') =>
argv.noTools?.includes(toolType) ? false
: argv.tools?.includes(toolType) ? true
: undefined;
const includeDynamicTools = shouldIncludeToolType('dynamic');
const includeAllTools = shouldIncludeToolType('all');
const includeCodeTools = shouldIncludeToolType('code');
const includeDocsTools = shouldIncludeToolType('docs');
const transport = argv.transport as 'stdio' | 'http';
const client = argv.client as ClientType;
return {
client: client && client !== 'infer' && knownClients[client] ? client : undefined,
includeDynamicTools,
includeAllTools,
includeCodeTools,
includeDocsTools,
filters,
capabilities: clientCapabilities,
list: argv.list || false,
transport,
port: argv.port,
socket: argv.socket,
};
}
const coerceArray = <T extends z.ZodTypeAny>(zodType: T) =>
z.preprocess(
(val) =>
Array.isArray(val) ? val
: val ? [val]
: val,
z.array(zodType).optional(),
);
const QueryOptions = z.object({
tools: coerceArray(z.enum(['dynamic', 'all', 'docs'])).describe('Use dynamic tools or all tools'),
no_tools: coerceArray(z.enum(['dynamic', 'all', 'docs'])).describe('Do not use dynamic tools or all tools'),
tool: coerceArray(z.string()).describe('Include tools matching the specified names'),
resource: coerceArray(z.string()).describe('Include tools matching the specified resources'),
operation: coerceArray(z.enum(['read', 'write'])).describe(
'Include tools matching the specified operations',
),
tag: coerceArray(z.string()).describe('Include tools with the specified tags'),
no_tool: coerceArray(z.string()).describe('Exclude tools matching the specified names'),
no_resource: coerceArray(z.string()).describe('Exclude tools matching the specified resources'),
no_operation: coerceArray(z.enum(['read', 'write'])).describe(
'Exclude tools matching the specified operations',
),
no_tag: coerceArray(z.string()).describe('Exclude tools with the specified tags'),
client: ClientType.optional().describe('Specify the MCP client being used'),
capability: coerceArray(z.string()).describe('Specify client capabilities'),
no_capability: coerceArray(z.enum(CAPABILITY_CHOICES)).describe('Unset client capabilities'),
});
export function parseQueryOptions(defaultOptions: McpOptions, query: unknown): McpOptions {
const queryObject = typeof query === 'string' ? qs.parse(query) : query;
const queryOptions = QueryOptions.parse(queryObject);
const filters: Filter[] = [...(defaultOptions.filters ?? [])];
for (const resource of queryOptions.resource || []) {
filters.push({ type: 'resource', op: 'include', value: resource });
}
for (const operation of queryOptions.operation || []) {
filters.push({ type: 'operation', op: 'include', value: operation });
}
for (const tag of queryOptions.tag || []) {
filters.push({ type: 'tag', op: 'include', value: tag });
}
for (const tool of queryOptions.tool || []) {
filters.push({ type: 'tool', op: 'include', value: tool });
}
for (const resource of queryOptions.no_resource || []) {
filters.push({ type: 'resource', op: 'exclude', value: resource });
}
for (const operation of queryOptions.no_operation || []) {
filters.push({ type: 'operation', op: 'exclude', value: operation });
}
for (const tag of queryOptions.no_tag || []) {
filters.push({ type: 'tag', op: 'exclude', value: tag });
}
for (const tool of queryOptions.no_tool || []) {
filters.push({ type: 'tool', op: 'exclude', value: tool });
}
// Parse client capabilities
const clientCapabilities: Partial<ClientCapabilities> = { ...defaultOptions.capabilities };
for (const cap of queryOptions.capability || []) {
const parsed = parseCapabilityValue(cap);
if (parsed.name === 'top-level-unions') {
clientCapabilities.topLevelUnions = true;
} else if (parsed.name === 'valid-json') {
clientCapabilities.validJson = true;
} else if (parsed.name === 'refs') {
clientCapabilities.refs = true;
} else if (parsed.name === 'unions') {
clientCapabilities.unions = true;
} else if (parsed.name === 'formats') {
clientCapabilities.formats = true;
} else if (parsed.name === 'tool-name-length') {
clientCapabilities.toolNameLength = parsed.value;
}
}
for (const cap of queryOptions.no_capability || []) {
if (cap === 'top-level-unions') {
clientCapabilities.topLevelUnions = false;
} else if (cap === 'valid-json') {
clientCapabilities.validJson = false;
} else if (cap === 'refs') {
clientCapabilities.refs = false;
} else if (cap === 'unions') {
clientCapabilities.unions = false;
} else if (cap === 'formats') {
clientCapabilities.formats = false;
} else if (cap === 'tool-name-length') {
clientCapabilities.toolNameLength = undefined;
}
}
let dynamicTools: boolean | undefined =
queryOptions.no_tools && queryOptions.no_tools?.includes('dynamic') ? false
: queryOptions.tools?.includes('dynamic') ? true
: defaultOptions.includeDynamicTools;
let allTools: boolean | undefined =
queryOptions.no_tools && queryOptions.no_tools?.includes('all') ? false
: queryOptions.tools?.includes('all') ? true
: defaultOptions.includeAllTools;
let docsTools: boolean | undefined =
queryOptions.no_tools && queryOptions.no_tools?.includes('docs') ? false
: queryOptions.tools?.includes('docs') ? true
: defaultOptions.includeDocsTools;
return {
client: queryOptions.client ?? defaultOptions.client,
includeDynamicTools: dynamicTools,
includeAllTools: allTools,
includeCodeTools: undefined,
includeDocsTools: docsTools,
filters,
capabilities: clientCapabilities,
};
}
function getCapabilitiesExplanation(): string {
return `
Client Capabilities Explanation:
Different Language Models (LLMs) and the MCP clients that use them have varying limitations in how they handle tool schemas. Capability flags allow you to inform the MCP server about these limitations.
When a capability flag is set to false, the MCP server will automatically adjust the tool schemas to work around that limitation, ensuring broader compatibility.
Available Capabilities:
# top-level-unions
Some clients/LLMs do not support JSON schemas with a union type (anyOf) at the root level. If a client lacks this capability, the MCP server splits tools with top-level unions into multiple separate tools, one for each variant in the union.
# refs
Some clients/LLMs do not support $ref pointers for schema reuse. If a client lacks this capability, the MCP server automatically inlines all references ($defs) directly into the schema. Properties that would cause circular references are removed during this process.
# valid-json
Some clients/LLMs may incorrectly send arguments as a JSON-encoded string instead of a proper JSON object. If a client *has* this capability, the MCP server will attempt to parse string values as JSON if the initial validation against the schema fails.
# unions
Some clients/LLMs do not support union types (anyOf) in JSON schemas. If a client lacks this capability, the MCP server removes all anyOf fields and uses only the first variant as the schema.
# formats
Some clients/LLMs do not support the 'format' keyword in JSON Schema specifications. If a client lacks this capability, the MCP server removes all format fields and appends the format information to the field's description in parentheses.
# tool-name-length=N
Some clients/LLMs impose a maximum length on tool names. If this capability is set, the MCP server will automatically truncate tool names exceeding the specified length (N), ensuring uniqueness by appending numbers if necessary.
Client Presets (--client):
Presets like '--client=openai-agents' or '--client=cursor' automatically configure these capabilities based on current known limitations of those clients, simplifying setup.
Current presets:
${JSON.stringify(knownClients, null, 2)}
`;
}
function examples(): [string, string][] {
const firstEndpoint = endpoints[0]!;
const secondEndpoint =
endpoints.find((e) => e.metadata.resource !== firstEndpoint.metadata.resource) || endpoints[1];
const tag = endpoints.find((e) => e.metadata.tags.length > 0)?.metadata.tags[0];
const otherEndpoint = secondEndpoint || firstEndpoint;
return [
[
`--tool="${firstEndpoint.tool.name}" ${secondEndpoint ? `--tool="${secondEndpoint.tool.name}"` : ''}`,
'Include tools by name',
],
[
`--resource="${firstEndpoint.metadata.resource}" --operation="read"`,
'Filter by resource and operation',
],
[
`--resource="${otherEndpoint.metadata.resource}*" --no-tool="${otherEndpoint.tool.name}"`,
'Use resource wildcards and exclusions',
],
[`--client="cursor"`, 'Adjust schemas to be more compatible with Cursor'],
[
`--capability="top-level-unions" --capability="tool-name-length=40"`,
'Specify individual client capabilities',
],
[
`--client="cursor" --no-capability="tool-name-length"`,
'Use cursor client preset but remove tool name length limit',
],
...(tag ? [[`--tag="${tag}"`, 'Filter based on tags'] as [string, string]] : []),
];
}