Making Stricter

Author: swapnil-nagar

src/utils/toolProperties.ts

@@ -1,7 +1,7 @@
 // Copyright (c) .NET Foundation. All rights reserved.
 // Licensed under the MIT License.
 
-import { McpToolProperty, ToolProps } from '../../types/mcpTool';
+import { Args, McpToolProperty } from '../../types/mcpTool';
 
 /**
  * Fluent API builder for creating MCP Tool properties
@@ -192,8 +192,8 @@ export const arg = {
  * @param toolProps - Object with property names as keys and ToolProperty as values
  * @returns Array of McpToolProperty objects with propertyName set correctly
  */
-export function convertToolProperties(toolProps: ToolProps): McpToolProperty[] {
-    return Object.entries(toolProps).map(([propertyName, property]) => ({
+export function convertToolProperties(args: Args): McpToolProperty[] {
+    return Object.entries(args).map(([propertyName, property]) => ({
         propertyName,
         propertyType: property.propertyType,
         description: property.description || '', // Default to empty string if not provided
@@ -205,7 +205,7 @@ export function convertToolProperties(toolProps: ToolProps): McpToolProperty[] {
 /**
  * Type guard to check if properties are in toolProp format
  */
-export function isToolProperties(properties: unknown): properties is ToolProps {
+export function isToolProperties(properties: unknown): properties is Args {
     return (
         typeof properties === 'object' &&
         properties !== null &&
@@ -243,7 +243,7 @@ function validateToolProperty(property: McpToolProperty, propertyName?: string):
  * Supports both legacy array format and new toolProp object format
  */
 export function normalizeToolProperties(
-    properties: McpToolProperty[] | ToolProps | undefined
+    properties: McpToolProperty[] | Args | undefined
 ): McpToolProperty[] | undefined {
     if (!properties) {
         return undefined;

test/converters/toMcpToolTriggerOptionsToRpc.test.ts

@@ -5,7 +5,7 @@ import 'mocha';
 import { expect } from 'chai';
 import { converToMcpToolTriggerOptionsToRpc } from '../../src/converters/toMcpToolTriggerOptionsToRpc';
 import { arg } from '../../src/utils/toolProperties';
-import { McpToolProperty, McpToolTriggerOptions, ToolProps } from '../../types/mcpTool';
+import { Args, McpToolProperty, McpToolTriggerOptions } from '../../types/mcpTool';
 
 describe('converToMcpToolTriggerOptionsToRpc', () => {
     describe('basic conversion', () => {
@@ -89,7 +89,7 @@ describe('converToMcpToolTriggerOptionsToRpc', () => {
 
     describe('toolProps object format', () => {
         it('should handle toolProps object format', () => {
-            const toolProperties: ToolProps = {
+            const toolProperties: Args = {
                 name: arg.string().describe('The name of the item'),
                 age: arg.number().describe('The age of the person').optional(),
             };
@@ -115,7 +115,7 @@ describe('converToMcpToolTriggerOptionsToRpc', () => {
         });
 
         it('should handle all supported property types', () => {
-            const toolProperties: ToolProps = {
+            const toolProperties: Args = {
                 stringProp: arg.string().describe('A string property'),
                 numberProp: arg.number().describe('A number property').optional(),
                 booleanProp: arg.boolean().describe('A boolean property'),
@@ -139,7 +139,7 @@ describe('converToMcpToolTriggerOptionsToRpc', () => {
         });
 
         it('should handle array properties correctly', () => {
-            const toolProperties: ToolProps = {
+            const toolProperties: Args = {
                 stringArray: arg.string().describe('A string array').asArray().optional(),
                 numberArray: arg.number().describe('A number array').asArray(),
             };
@@ -311,7 +311,7 @@ describe('converToMcpToolTriggerOptionsToRpc', () => {
 
     describe('JSON serialization', () => {
         it('should produce valid JSON in toolProperties', () => {
-            const toolProperties: ToolProps = {
+            const toolProperties: Args = {
                 test: arg.string().describe('Test property'),
             };
 
@@ -351,7 +351,7 @@ describe('converToMcpToolTriggerOptionsToRpc', () => {
 
     describe('edge cases', () => {
         it('should handle properties with special characters', () => {
-            const toolProperties: ToolProps = {
+            const toolProperties: Args = {
                 'special-field_with$symbols': arg.string().describe('A property with special characters in name'),
             };
 
@@ -371,7 +371,7 @@ describe('converToMcpToolTriggerOptionsToRpc', () => {
         });
 
         it('should handle properties with non-empty descriptions', () => {
-            const toolProperties: ToolProps = {
+            const toolProperties: Args = {
                 validDesc: arg.string().describe('A valid description'),
             };
 
@@ -390,7 +390,7 @@ describe('converToMcpToolTriggerOptionsToRpc', () => {
             expect(parsedProperties).to.have.length(1);
         });
         it('should handle whitespace in names and descriptions', () => {
-            const toolProperties: ToolProps = {
+            const toolProperties: Args = {
                 '  spaced name  ': arg.string().describe('  spaced description  ').optional(),
             };
 

types/mcpTool.d.ts

@@ -48,9 +48,9 @@ export interface McpToolTriggerOptions {
 
     /**
      * Additional properties or metadata for the tool.
-     * Can be provided as an array (legacy format) or as a toolProp object format.
+     * Can be provided as an array or as a Args object format.
      */
-    toolProperties?: McpToolProperty[] | ToolProps | any;
+    toolProperties?: McpToolProperty[] | Args;
 }
 
 /**
@@ -114,9 +114,9 @@ export interface McpToolProperty {
 /**
  * Represents a tool property definition (same as McpToolProperty but without propertyName)
  */
-export type ToolProperty = Omit<McpToolProperty, 'propertyName'>;
+export type Arg = Omit<McpToolProperty, 'propertyName'>;
 
 /**
  * Tool properties format - an object mapping property names to their definitions
  */
-export type ToolProps = Record<string, ToolProperty>;
+export type Args = Record<string, Arg>;