File size: 4,099 Bytes
a5d718a | 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 | "use strict";
/**
* Tool name validation utilities according to SEP: Specify Format for Tool Names
*
* Tool names SHOULD be between 1 and 128 characters in length (inclusive).
* Tool names are case-sensitive.
* Allowed characters: uppercase and lowercase ASCII letters (A-Z, a-z), digits
* (0-9), underscore (_), dash (-), and dot (.).
* Tool names SHOULD NOT contain spaces, commas, or other special characters.
*/
Object.defineProperty(exports, "__esModule", { value: true });
exports.validateToolName = validateToolName;
exports.issueToolNameWarning = issueToolNameWarning;
exports.validateAndWarnToolName = validateAndWarnToolName;
/**
* Regular expression for valid tool names according to SEP-986 specification
*/
const TOOL_NAME_REGEX = /^[A-Za-z0-9._-]{1,128}$/;
/**
* Validates a tool name according to the SEP specification
* @param name - The tool name to validate
* @returns An object containing validation result and any warnings
*/
function validateToolName(name) {
const warnings = [];
// Check length
if (name.length === 0) {
return {
isValid: false,
warnings: ['Tool name cannot be empty']
};
}
if (name.length > 128) {
return {
isValid: false,
warnings: [`Tool name exceeds maximum length of 128 characters (current: ${name.length})`]
};
}
// Check for specific problematic patterns (these are warnings, not validation failures)
if (name.includes(' ')) {
warnings.push('Tool name contains spaces, which may cause parsing issues');
}
if (name.includes(',')) {
warnings.push('Tool name contains commas, which may cause parsing issues');
}
// Check for potentially confusing patterns (leading/trailing dashes, dots, slashes)
if (name.startsWith('-') || name.endsWith('-')) {
warnings.push('Tool name starts or ends with a dash, which may cause parsing issues in some contexts');
}
if (name.startsWith('.') || name.endsWith('.')) {
warnings.push('Tool name starts or ends with a dot, which may cause parsing issues in some contexts');
}
// Check for invalid characters
if (!TOOL_NAME_REGEX.test(name)) {
const invalidChars = name
.split('')
.filter(char => !/[A-Za-z0-9._-]/.test(char))
.filter((char, index, arr) => arr.indexOf(char) === index); // Remove duplicates
warnings.push(`Tool name contains invalid characters: ${invalidChars.map(c => `"${c}"`).join(', ')}`, 'Allowed characters are: A-Z, a-z, 0-9, underscore (_), dash (-), and dot (.)');
return {
isValid: false,
warnings
};
}
return {
isValid: true,
warnings
};
}
/**
* Issues warnings for non-conforming tool names
* @param name - The tool name that triggered the warnings
* @param warnings - Array of warning messages
*/
function issueToolNameWarning(name, warnings) {
if (warnings.length > 0) {
console.warn(`Tool name validation warning for "${name}":`);
for (const warning of warnings) {
console.warn(` - ${warning}`);
}
console.warn('Tool registration will proceed, but this may cause compatibility issues.');
console.warn('Consider updating the tool name to conform to the MCP tool naming standard.');
console.warn('See SEP: Specify Format for Tool Names (https://github.com/modelcontextprotocol/modelcontextprotocol/issues/986) for more details.');
}
}
/**
* Validates a tool name and issues warnings for non-conforming names
* @param name - The tool name to validate
* @returns true if the name is valid, false otherwise
*/
function validateAndWarnToolName(name) {
const result = validateToolName(name);
// Always issue warnings for any validation issues (both invalid names and warnings)
issueToolNameWarning(name, result.warnings);
return result.isValid;
}
//# sourceMappingURL=toolNameValidation.js.map |