api2ai 1.0.1

package/example-petstore/src/tools-config.js

@@ -0,0 +1,247 @@
+// Tool configurations extracted from OpenAPI spec
+// Generated: 2025-12-30T23:36:57.080Z
+
+export const toolConfigs = [
+  {
+    "name": "addPet",
+    "description": "Add a new pet to the store.",
+    "method": "post",
+    "pathTemplate": "/pet",
+    "executionParameters": [],
+    "requestBodyContentType": "application/json",
+    "baseUrl": "/api/v3"
+  },
+  {
+    "name": "updatePet",
+    "description": "Update an existing pet.",
+    "method": "put",
+    "pathTemplate": "/pet",
+    "executionParameters": [],
+    "requestBodyContentType": "application/json",
+    "baseUrl": "/api/v3"
+  },
+  {
+    "name": "findPetsByStatus",
+    "description": "Finds Pets by status.",
+    "method": "get",
+    "pathTemplate": "/pet/findByStatus",
+    "executionParameters": [
+      {
+        "name": "status",
+        "in": "query"
+      }
+    ],
+    "baseUrl": "/api/v3"
+  },
+  {
+    "name": "findPetsByTags",
+    "description": "Finds Pets by tags.",
+    "method": "get",
+    "pathTemplate": "/pet/findByTags",
+    "executionParameters": [
+      {
+        "name": "tags",
+        "in": "query"
+      }
+    ],
+    "baseUrl": "/api/v3"
+  },
+  {
+    "name": "getPetById",
+    "description": "Find pet by ID.",
+    "method": "get",
+    "pathTemplate": "/pet/{petId}",
+    "executionParameters": [
+      {
+        "name": "petId",
+        "in": "path"
+      }
+    ],
+    "baseUrl": "/api/v3"
+  },
+  {
+    "name": "updatePetWithForm",
+    "description": "Updates a pet in the store with form data.",
+    "method": "post",
+    "pathTemplate": "/pet/{petId}",
+    "executionParameters": [
+      {
+        "name": "petId",
+        "in": "path"
+      },
+      {
+        "name": "name",
+        "in": "query"
+      },
+      {
+        "name": "status",
+        "in": "query"
+      }
+    ],
+    "baseUrl": "/api/v3"
+  },
+  {
+    "name": "deletePet",
+    "description": "Deletes a pet.",
+    "method": "delete",
+    "pathTemplate": "/pet/{petId}",
+    "executionParameters": [
+      {
+        "name": "api_key",
+        "in": "header"
+      },
+      {
+        "name": "petId",
+        "in": "path"
+      }
+    ],
+    "baseUrl": "/api/v3"
+  },
+  {
+    "name": "uploadFile",
+    "description": "Uploads an image.",
+    "method": "post",
+    "pathTemplate": "/pet/{petId}/uploadImage",
+    "executionParameters": [
+      {
+        "name": "petId",
+        "in": "path"
+      },
+      {
+        "name": "additionalMetadata",
+        "in": "query"
+      }
+    ],
+    "requestBodyContentType": "application/octet-stream",
+    "baseUrl": "/api/v3"
+  },
+  {
+    "name": "getInventory",
+    "description": "Returns pet inventories by status.",
+    "method": "get",
+    "pathTemplate": "/store/inventory",
+    "executionParameters": [],
+    "baseUrl": "/api/v3"
+  },
+  {
+    "name": "placeOrder",
+    "description": "Place an order for a pet.",
+    "method": "post",
+    "pathTemplate": "/store/order",
+    "executionParameters": [],
+    "requestBodyContentType": "application/json",
+    "baseUrl": "/api/v3"
+  },
+  {
+    "name": "getOrderById",
+    "description": "Find purchase order by ID.",
+    "method": "get",
+    "pathTemplate": "/store/order/{orderId}",
+    "executionParameters": [
+      {
+        "name": "orderId",
+        "in": "path"
+      }
+    ],
+    "baseUrl": "/api/v3"
+  },
+  {
+    "name": "deleteOrder",
+    "description": "Delete purchase order by identifier.",
+    "method": "delete",
+    "pathTemplate": "/store/order/{orderId}",
+    "executionParameters": [
+      {
+        "name": "orderId",
+        "in": "path"
+      }
+    ],
+    "baseUrl": "/api/v3"
+  },
+  {
+    "name": "createUser",
+    "description": "Create user.",
+    "method": "post",
+    "pathTemplate": "/user",
+    "executionParameters": [],
+    "requestBodyContentType": "application/json",
+    "baseUrl": "/api/v3"
+  },
+  {
+    "name": "createUsersWithListInput",
+    "description": "Creates list of users with given input array.",
+    "method": "post",
+    "pathTemplate": "/user/createWithList",
+    "executionParameters": [],
+    "requestBodyContentType": "application/json",
+    "baseUrl": "/api/v3"
+  },
+  {
+    "name": "loginUser",
+    "description": "Logs user into the system.",
+    "method": "get",
+    "pathTemplate": "/user/login",
+    "executionParameters": [
+      {
+        "name": "username",
+        "in": "query"
+      },
+      {
+        "name": "password",
+        "in": "query"
+      }
+    ],
+    "baseUrl": "/api/v3"
+  },
+  {
+    "name": "logoutUser",
+    "description": "Logs out current logged in user session.",
+    "method": "get",
+    "pathTemplate": "/user/logout",
+    "executionParameters": [],
+    "baseUrl": "/api/v3"
+  },
+  {
+    "name": "getUserByName",
+    "description": "Get user by user name.",
+    "method": "get",
+    "pathTemplate": "/user/{username}",
+    "executionParameters": [
+      {
+        "name": "username",
+        "in": "path"
+      }
+    ],
+    "baseUrl": "/api/v3"
+  },
+  {
+    "name": "updateUser",
+    "description": "Update user resource.",
+    "method": "put",
+    "pathTemplate": "/user/{username}",
+    "executionParameters": [
+      {
+        "name": "username",
+        "in": "path"
+      }
+    ],
+    "requestBodyContentType": "application/json",
+    "baseUrl": "/api/v3"
+  },
+  {
+    "name": "deleteUser",
+    "description": "Delete user resource.",
+    "method": "delete",
+    "pathTemplate": "/user/{username}",
+    "executionParameters": [
+      {
+        "name": "username",
+        "in": "path"
+      }
+    ],
+    "baseUrl": "/api/v3"
+  }
+];
+
+// Create a map for quick lookup
+export const toolConfigMap = new Map(toolConfigs.map(t => [t.name, t]));

package/example.js

@@ -0,0 +1,164 @@
+/**
+ * Example: Programmatic usage of the OpenAPI to MCP-Use generator
+ * 
+ * This script demonstrates various ways to use the generator.
+ */
+
+import { generateMcpServer, extractTools, loadOpenApiSpec } from './generate-mcp-use-server.js';
+
+// ============================================================================
+// Example 1: Generate from a remote URL
+// ============================================================================
+
+async function generateFromUrl() {
+  console.log('Example 1: Generate from URL\n');
+  
+  const result = await generateMcpServer(
+    'https://petstore3.swagger.io/api/v3/openapi.json',
+    './petstore-mcp',
+    {
+      serverName: 'petstore-api',
+      baseUrl: 'https://petstore3.swagger.io/api/v3',
+      port: 3000,
+    }
+  );
+  
+  console.log('Generated tools:', result.tools.slice(0, 5), '...');
+}
+
+// ============================================================================
+// Example 2: Generate with filtering
+// ============================================================================
+
+async function generateWithFiltering() {
+  console.log('Example 2: Generate with filtering\n');
+  
+  const result = await generateMcpServer(
+    'https://petstore3.swagger.io/api/v3/openapi.json',
+    './petstore-readonly',
+    {
+      serverName: 'petstore-readonly',
+      // Only include GET endpoints (read-only)
+      filterFn: (tool) => tool.method.toLowerCase() === 'get',
+      port: 3001,
+    }
+  );
+  
+  console.log(`Generated ${result.toolCount} read-only tools`);
+}
+
+// ============================================================================
+// Example 3: Extract tools without generating server
+// ============================================================================
+
+async function extractToolsOnly() {
+  console.log('Example 3: Extract tools only\n');
+  
+  const spec = await loadOpenApiSpec('https://petstore3.swagger.io/api/v3/openapi.json');
+  
+  console.log(`API: ${spec.info.title} v${spec.info.version}`);
+  
+  const tools = extractTools(spec, {
+    baseUrl: 'https://petstore3.swagger.io/api/v3',
+    // Exclude dangerous operations
+    excludeOperationIds: ['deletePet', 'deleteOrder', 'deleteUser'],
+    // Only include pet-related endpoints
+    filterFn: (tool) => tool.pathTemplate.includes('/pet'),
+  });
+  
+  console.log('\nExtracted pet-related tools:');
+  tools.forEach(tool => {
+    console.log(`  ${tool.method.toUpperCase().padEnd(6)} ${tool.pathTemplate}`);
+    console.log(`    → ${tool.name}: ${tool.description}`);
+  });
+}
+
+// ============================================================================
+// Example 4: Generate from local file
+// ============================================================================
+
+async function generateFromLocalFile() {
+  console.log('Example 4: Generate from local file\n');
+  
+  // This would work with a local file:
+  // const result = await generateMcpServer(
+  //   './my-api-spec.yaml',
+  //   './my-api-mcp',
+  //   {
+  //     serverName: 'my-api',
+  //     port: 3002,
+  //   }
+  // );
+  
+  console.log('(Skipped - requires local file)');
+}
+
+// ============================================================================
+// Example 5: Advanced - Custom tool processing
+// ============================================================================
+
+async function advancedUsage() {
+  console.log('Example 5: Advanced tool processing\n');
+  
+  const spec = await loadOpenApiSpec('https://petstore3.swagger.io/api/v3/openapi.json');
+  const tools = extractTools(spec);
+  
+  // Analyze the tools
+  const methodCounts = {};
+  const tagCounts = {};
+  
+  tools.forEach(tool => {
+    methodCounts[tool.method] = (methodCounts[tool.method] || 0) + 1;
+  });
+  
+  console.log('Tools by HTTP method:');
+  Object.entries(methodCounts)
+    .sort((a, b) => b[1] - a[1])
+    .forEach(([method, count]) => {
+      console.log(`  ${method.toUpperCase()}: ${count} tools`);
+    });
+  
+  console.log('\nTools with request body:', 
+    tools.filter(t => t.requestBodyContentType).length);
+  
+  console.log('Tools requiring path params:', 
+    tools.filter(t => t.executionParameters.some(p => p.in === 'path')).length);
+}
+
+// ============================================================================
+// Run examples
+// ============================================================================
+
+async function main() {
+  const example = process.argv[2] || 'all';
+  
+  try {
+    switch (example) {
+      case '1':
+        await generateFromUrl();
+        break;
+      case '2':
+        await generateWithFiltering();
+        break;
+      case '3':
+        await extractToolsOnly();
+        break;
+      case '4':
+        await generateFromLocalFile();
+        break;
+      case '5':
+        await advancedUsage();
+        break;
+      case 'all':
+      default:
+        // Just run the analysis example by default
+        await advancedUsage();
+        console.log('\n---\nRun specific example with: node example.js [1-5]');
+    }
+  } catch (error) {
+    console.error('Error:', error.message);
+    process.exit(1);
+  }
+}
+
+main();