api2ai 1.0.23 → 1.0.25

package/README.md

@@ -1,20 +1,49 @@
 
 <p align="center">
-    <img src="https://i.imgur.com/6CKuUBa.png" /><br />
-   <a href="https://npmjs.org/package/grab-url"><img alt="NPM Version" src="https://img.shields.io/npm/v/grab-url" /></a><a href="https://github.com/vtempest/GRAB-URL/discussions"><img alt="GitHub Discussions"
-        src="https://img.shields.io/github/discussions/vtempest/GRAB-URL" /></a><a href="https://github.blog/developer-skills/github/beginners-guide-to-github-creating-a-pull-request/"><img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg" alt="PRs Welcome"/></a>
+    <img width="600px" src="https://i.imgur.com/TTJBLxo.png" />
 </p>
 
+<!-- template-git-repo:badges:start -->
+<p align="center">
+    <a href="https://1computer.online/docs/packages/api2ai-mcp-generator"><img src="https://img.shields.io/badge/Docs-blue?logo=ReadTheDocs&logoColor=white" alt="Documentation" /></a>
+    <br />
+    <a href="https://github.com/OpenSourceAGI/dev-tools-starter-agent/stargazers"><img src="https://img.shields.io/github/stars/OpenSourceAGI/dev-tools-starter-agent" alt="GitHub Stars" /></a>
+    <a href="https://www.npmjs.com/package/api2ai"><img src="https://img.shields.io/npm/dm/api2ai.svg" alt="NPM Monthly Downloads" /></a>
+    <a href="https://www.npmjs.com/package/api2ai"><img src="https://img.shields.io/npm/v/api2ai.svg" alt="npm version" /></a>
+    <a href="https://www.npmjs.com/package/api2ai"><img src="https://img.shields.io/npm/dt/api2ai.svg" alt="NPM Total Downloads" /></a>
+    <a href="https://www.npmjs.com/package/api2ai"><img src="https://img.shields.io/npm/types/api2ai" alt="TypeScript types" /></a>
+    <a href="https://packagephobia.com/result?p=api2ai"><img src="https://packagephobia.com/badge?p=api2ai" alt="Install size" /></a>
+    <br />
+    <a href="https://github.com/OpenSourceAGI/dev-tools-starter-agent/issues"><img src="https://img.shields.io/github/issues/OpenSourceAGI/dev-tools-starter-agent?logo=github" alt="GitHub Issues" /></a>
+    <a href="https://github.com/OpenSourceAGI/dev-tools-starter-agent/pulls"><img src="https://img.shields.io/github/issues-pr/OpenSourceAGI/dev-tools-starter-agent?logo=github&label=PRs" alt="Open Pull Requests" /></a>
+    <a href="https://github.com/OpenSourceAGI/dev-tools-starter-agent/pulls?q=is%3Apr+is%3Aclosed"><img src="https://img.shields.io/github/issues-pr-closed/OpenSourceAGI/dev-tools-starter-agent?logo=github&label=PRs%20merged&color=8957e5" alt="Merged Pull Requests" /></a>
+    <a href="https://github.com/OpenSourceAGI/dev-tools-starter-agent/discussions"><img src="https://img.shields.io/github/discussions/OpenSourceAGI/dev-tools-starter-agent" alt="GitHub Discussions" /></a>
+    <a href="https://github.com/OpenSourceAGI/dev-tools-starter-agent/commits/master/"><img src="https://img.shields.io/github/last-commit/OpenSourceAGI/dev-tools-starter-agent.svg" alt="GitHub last commit" /></a>
+    <br />
+    <a href="https://stackblitz.com/github/OpenSourceAGI/dev-tools-starter-agent/tree/master/packages/api2ai-mcp-generator"><img height="20px" src="https://developer.stackblitz.com/img/open_in_stackblitz.svg" alt="Open in StackBlitz" /></a>
+    <img src="https://img.shields.io/badge/Bun-14151A?logo=bun&logoColor=white" alt="Bun" /> <img src="https://img.shields.io/badge/TypeScript-3178C6?logo=typescript&logoColor=white" alt="TypeScript" /> <img src="https://img.shields.io/badge/Next.js-black?logo=nextdotjs&logoColor=white" alt="Next.js" /> <img src="https://img.shields.io/badge/React-20232A?logo=react&logoColor=white" alt="React" /> <img src="https://img.shields.io/badge/Tailwind%20CSS-06B6D4?logo=tailwindcss&logoColor=white" alt="Tailwind CSS" /> <img src="https://img.shields.io/badge/shadcn%2Fui-000000?logo=shadcnui&logoColor=white" alt="shadcn/ui" /> <img src="https://img.shields.io/badge/Drizzle%20ORM-C5F74F?logo=drizzle&logoColor=white" alt="Drizzle ORM" /> <img src="https://img.shields.io/badge/better--auth-000000" alt="better-auth" /> <img src="https://img.shields.io/badge/Stripe-635BFF?logo=stripe&logoColor=white" alt="Stripe" /> <img src="https://img.shields.io/badge/Vercel%20AI%20SDK-black?logo=vercel&logoColor=white" alt="Vercel AI SDK" /> <img src="https://img.shields.io/badge/Zod-3E67B1?logo=zod&logoColor=white" alt="Zod" /> <img src="https://img.shields.io/badge/Fumadocs-000000" alt="Fumadocs" /> <img src="https://img.shields.io/badge/Vite-646CFF?logo=vite&logoColor=white" alt="Vite" /> <img src="https://img.shields.io/badge/Vitest-6E9F18?logo=vitest&logoColor=white" alt="Vitest" />
+</p>
+<!-- template-git-repo:badges:end -->
 
-# API2AI: OpenAPI to MCP-Use Server 
+<!-- skills:install:start -->
+**🤖 Agent skill** — `npx skills@latest add https://github.com/OpenSourceAGI/dev-tools-starter-agent --skill api2ai` ([what it covers](../../skills/api2ai/SKILL.md))
+<!-- skills:install:end -->
+
+<h3 align="center">
+  <a href="https://api-2-ai.vercel.app/"> 🌐 Live Site </a> &nbsp;|&nbsp;
+  <a href="https://github.com/vtempest/GRAB-URL/tree/master/api2ai/example-petstore"> 🎯 Example MCP Server </a>
+</h3>
 
-  <a href="https://github.com/OpenSourceAGI/GRAB-URL/tree/master/examples/openapi-mcp-docs"> 🎯 Example MCP Server </a>
 
 
+
+# API2AI: OpenAPI to MCP-Use Server 
+
 Generate production-ready MCP servers from any OpenAPI specification using the highly-used and convenient [mcp-use](https://mcp-use.com) framework (8k+ GitHub stars).
 
 OpenAPI specs are easy to write and organize your code and have [100s of tools available](https://openapi.tools) such as the [OpenAPI Builder web UI](https://www.apibldr.com).
 
+Try it in the browser at **[api-2-ai.vercel.app](https://api-2-ai.vercel.app/)** — the hosted site lets you design and validate OpenAPI specs visually, browse the docs, and see generated-server examples without installing anything.
 
 ## Features
 
@@ -49,7 +78,7 @@ Open http://localhost:3000/inspector to test your tools!
 ### CLI
 
 ```bash
-npx api2ai <openapi-spec> [output-folder] [options]
+node generate-mcp-use-server.js <openapi-spec> [output-folder] [options]
 
 Options:
   --name <name>            Server name (default: api-mcp-server)
@@ -66,32 +95,32 @@ Options:
 
 ```bash
 # From remote URL
-npx api2ai \
+node generate-mcp-use-server.js \
   https://api.example.com/openapi.json \
   ./my-server \
   --name my-api
 
 # From local file
-npx api2ai \
+node generate-mcp-use-server.js \
   ./specs/my-api.yaml \
   ./my-mcp-server \
   --port 8080
 
 # With custom base URL
-npx api2ai \
+node generate-mcp-use-server.js \
   ./petstore.json \
   ./petstore \
   --base-url https://petstore.example.com/v3
 
 # Include only read-only tools tagged "public"
-npx api2ai \
+node generate-mcp-use-server.js \
   ./api.json \
   ./readonly-server \
   --include-tags public \
   --exclude-tags admin,internal
 
 # Enable writes (mutations) explicitly
-npx api2ai \
+node generate-mcp-use-server.js \
   ./api.json \
   ./full-server \
   --allow-mutations \
@@ -101,29 +130,29 @@ npx api2ai \
 ### Programmatic Usage
 
 ```javascript
-import { generateMcpServer, extractTools, loadOpenApiSpec } from "api2ai";
+import { generateMcpServer, extractTools, loadOpenApiSpec } from './generate-mcp-use-server.js';
 
 // Generate complete server
 const result = await generateMcpServer(
-  "https://api.example.com/openapi.json",
-  "./output-folder",
+  'https://api.example.com/openapi.json',
+  './output-folder',
   {
-    serverName: "my-api",
-    baseUrl: "https://api.example.com/v1",
+    serverName: 'my-api',
+    baseUrl: 'https://api.example.com/v1',
     port: 3000,
     allowMutations: false,       // block POST/PUT/PATCH/DELETE by default
-    includeTags: ["public"],     // only include tools tagged "public"
-    excludeTags: ["admin"],      // exclude tools tagged "admin"
+    includeTags: ['public'],     // only include tools tagged "public"
+    excludeTags: ['admin'],      // exclude tools tagged "admin"
   }
 );
 
 console.log(`Generated ${result.toolCount} tools`);
 
 // Or just extract tools for custom processing
-const spec = await loadOpenApiSpec("./my-spec.json");
+const spec = await loadOpenApiSpec('./my-spec.json');
 const tools = extractTools(spec, {
-  filterFn: (tool) => tool.riskLevel === "low",  // only safe read-only tools
-  excludeOperationIds: ["deleteUser"],
+  filterFn: (tool) => tool.riskLevel === 'low',  // only safe read-only tools
+  excludeOperationIds: ['deleteUser'],
 });
 ```
 
@@ -230,7 +259,7 @@ The generated server supports the OpenAI Apps SDK out of the box.
 
 ```javascript
 const result = await generateMcpServer(specUrl, outputDir, {
-  filterFn: (tool) => tool.riskLevel === "low",
+  filterFn: (tool) => tool.riskLevel === 'low',
 });
 ```
 
@@ -238,7 +267,7 @@ const result = await generateMcpServer(specUrl, outputDir, {
 
 ```javascript
 const result = await generateMcpServer(specUrl, outputDir, {
-  filterFn: (tool) => ["get", "post"].includes(tool.method),
+  filterFn: (tool) => ['get', 'post'].includes(tool.method),
 });
 ```
 
@@ -247,9 +276,9 @@ const result = await generateMcpServer(specUrl, outputDir, {
 ```javascript
 const result = await generateMcpServer(specUrl, outputDir, {
   excludeOperationIds: [
-    "deleteUser",
-    "deleteAllData",
-    "adminReset",
+    'deleteUser',
+    'deleteAllData', 
+    'adminReset',
   ],
 });
 ```
@@ -258,7 +287,7 @@ const result = await generateMcpServer(specUrl, outputDir, {
 
 ```javascript
 const result = await generateMcpServer(specUrl, outputDir, {
-  filterFn: (tool) => tool.pathTemplate.startsWith("/api/v2/"),
+  filterFn: (tool) => tool.pathTemplate.startsWith('/api/v2/'),
 });
 ```
 
@@ -266,11 +295,11 @@ const result = await generateMcpServer(specUrl, outputDir, {
 
 ```javascript
 const result = await generateMcpServer(specUrl, outputDir, {
-  excludeOperationIds: ["deleteUser"],
+  excludeOperationIds: ['deleteUser'],
   allowMutations: false,
-  filterFn: (tool) =>
-    tool.riskLevel === "low" &&
-    tool.pathTemplate.includes("/public/"),
+  filterFn: (tool) => 
+    tool.riskLevel === 'low' && 
+    tool.pathTemplate.includes('/public/'),
 });
 ```
 
@@ -288,13 +317,8 @@ const result = await generateMcpServer(specUrl, outputDir, {
 | HTTP hardening | ✅ Built-in | ❌ Manual |
 | Production ready | ✅ Yes | ⚠️ Requires work |
 
-## Development
-
-```bash
-npm install
-node src/generate-mcp-use-server.js ./petstore.json ./out
-```
+---
 
-## License
+[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request)
 
-MIT
+Please star this repo for updates! 🌟

package/package.json

@@ -1,33 +1,247 @@
 {
   "name": "api2ai",
-  "version": "1.0.23",
-  "description": "Generate a production-ready MCP server (mcp-use framework) from any OpenAPI specification.",
-  "type": "module",
-  "bin": {
-    "api2ai": "./src/generate-mcp-use-server.js"
+  "version": "1.0.25",
+  "description": "Generate production-ready MCP servers from any OpenAPI specification using the highly-used and convenient [mcp-use](https://mcp-use.com) framework",
+  "license": "rights.institute/prosper",
+  "author": "vtempest",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/OpenSourceAGI/dev-tools-starter-agent.git",
+    "directory": "packages/api2ai-mcp-generator"
   },
-  "main": "./src/generate-mcp-use-server.js",
+  "homepage": "https://github.com/OpenSourceAGI/dev-tools-starter-agent/tree/master/packages/api2ai-mcp-generator",
+  "keywords": [
+    "mcp",
+    "mcp-server",
+    "model-context-protocol",
+    "openapi",
+    "api",
+    "ai",
+    "code-generator",
+    "zod"
+  ],
   "exports": {
-    ".": "./src/generate-mcp-use-server.js"
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
+    }
   },
-  "optionalDependencies": {
-    "js-yaml": "^4.1.1"
+  "main": "dist/index.js",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "next build",
+    "db:create": "npm create cloud-db",
+    "db:generate": "drizzle-kit generate",
+    "db:push": "drizzle-kit push",
+    "db:studio": "concurrently \"drizzle-kit studio\" \"wait-on https://local.drizzle.studio && opener https://local.drizzle.studio\"",
+    "dev": "concurrently \"next dev\" \"wait-on http://localhost:3000 && opener http://localhost:3000\"",
+    "docs:check": "fumadocs check",
+    "docs:generate": "fumadocs-mdx",
+    "make": "concurrently \"next build && next start \" \"wait-on http://localhost:3000 && opener http://localhost:3000\"",
+    "start": "next start",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "coverage": "vitest run --coverage"
   },
-  "engines": {
-    "node": ">=18.0.0"
+  "dependencies": {
+    "@ai-sdk/react": "3.0.3",
+    "@aws-sdk/client-rds-data": "latest",
+    "@better-auth/core": "latest",
+    "@better-auth/stripe": "^1.4.7",
+    "@cloudflare/workers-types": "latest",
+    "@electric-sql/pglite": "latest",
+    "@emotion/is-prop-valid": "latest",
+    "@fumadocs/mdx-remote": "^1.4.3",
+    "@langchain/core": "^1.1.5",
+    "@langchain/groq": "^1.0.2",
+    "@langchain/openai": "^1.2.0",
+    "@libsql/client": "^0.15.15",
+    "@libsql/client-wasm": "latest",
+    "@lynx-js/react": "latest",
+    "@mixedbread/sdk": "latest",
+    "@neondatabase/serverless": "latest",
+    "@op-engineering/op-sqlite": "latest",
+    "@opentelemetry/api": "latest",
+    "@orama/core": "latest",
+    "@planetscale/database": "latest",
+    "@prisma/client": "latest",
+    "@radix-ui/react-accordion": "1.2.12",
+    "@radix-ui/react-alert-dialog": "1.1.15",
+    "@radix-ui/react-aspect-ratio": "1.1.8",
+    "@radix-ui/react-avatar": "^1.1.11",
+    "@radix-ui/react-checkbox": "1.3.3",
+    "@radix-ui/react-collapsible": "^1.1.12",
+    "@radix-ui/react-context-menu": "2.2.16",
+    "@radix-ui/react-dialog": "^1.1.15",
+    "@radix-ui/react-dropdown-menu": "^2.1.16",
+    "@radix-ui/react-hover-card": "1.1.15",
+    "@radix-ui/react-label": "2.1.8",
+    "@radix-ui/react-menubar": "1.1.16",
+    "@radix-ui/react-navigation-menu": "1.2.14",
+    "@radix-ui/react-popover": "1.1.15",
+    "@radix-ui/react-presence": "1.1.5",
+    "@radix-ui/react-progress": "1.1.8",
+    "@radix-ui/react-radio-group": "^1.3.8",
+    "@radix-ui/react-scroll-area": "1.2.10",
+    "@radix-ui/react-select": "2.2.6",
+    "@radix-ui/react-separator": "^1.1.8",
+    "@radix-ui/react-slider": "1.3.6",
+    "@radix-ui/react-slot": "^1.2.4",
+    "@radix-ui/react-switch": "1.2.6",
+    "@radix-ui/react-tabs": "1.1.13",
+    "@radix-ui/react-toast": "1.2.15",
+    "@radix-ui/react-toggle": "1.1.10",
+    "@radix-ui/react-toggle-group": "1.1.11",
+    "@radix-ui/react-tooltip": "^1.2.8",
+    "@react-email/render": "latest",
+    "@react-three/drei": "^10.7.7",
+    "@react-three/fiber": "^9.4.2",
+    "@scalar/api-client-react": "latest",
+    "@scalar/api-reference": "^1.40.5",
+    "@scalar/api-reference-react": "^0.8.11",
+    "@shikijs/rehype": "^3.20.0",
+    "@shikijs/transformers": "^3.20.0",
+    "@silevis/reactgrid": "^4.1.17",
+    "@t3-oss/env-nextjs": "0.13.10",
+    "@tabler/icons-react": "^3.36.0",
+    "@tanstack/react-router": "latest",
+    "@tanstack/react-start": "latest",
+    "@tidbcloud/serverless": "latest",
+    "@types/better-sqlite3": "latest",
+    "@types/dompurify": "^3.2.0",
+    "@types/js-yaml": "^4.0.9",
+    "@types/marked": "^6.0.0",
+    "@types/pg": "latest",
+    "@types/sql.js": "latest",
+    "@upstash/redis": "latest",
+    "@vercel/analytics": "1.6.1",
+    "@vercel/postgres": "latest",
+    "@xata.io/client": "latest",
+    "ai": "6.0.3",
+    "algoliasearch": "latest",
+    "arktype": "latest",
+    "autoprefixer": "^10.4.22",
+    "axios": "^1.13.2",
+    "better-auth": "^1.4.7",
+    "better-sqlite3": "latest",
+    "bun-types": "latest",
+    "canvas": "latest",
+    "class-variance-authority": "^0.7.1",
+    "cli-highlight": "^2.1.11",
+    "clsx": "^2.1.1",
+    "cmdk": "^1.1.1",
+    "date-fns": "4.1.0",
+    "dompurify": "^3.3.1",
+    "dotenv": "^17.2.3",
+    "drizzle-orm": "^0.45.1",
+    "embla-carousel-react": "8.6.0",
+    "ethers": "^6.16.0",
+    "expo": "latest",
+    "expo-asset": "latest",
+    "expo-file-system": "latest",
+    "expo-gl": "latest",
+    "expo-sqlite": "latest",
+    "feed": "^5.1.0",
+    "fumadocs-core": "^16.2.5",
+    "fumadocs-mdx": "^14.1.1",
+    "fumadocs-openapi": "^10.1.4",
+    "fumadocs-twoslash": "^3.1.10",
+    "fumadocs-typescript": "^4.0.14",
+    "fumadocs-ui": "^16.2.5",
+    "gel": "latest",
+    "grab-url": "^1.0.15",
+    "hast-util-to-jsx-runtime": "2.3.6",
+    "highlight.js": "^11.11.1",
+    "jiti": "latest",
+    "js-yaml": "^4.1.1",
+    "jszip": "^3.10.1",
+    "katex": "^0.16.27",
+    "knex": "latest",
+    "kysely": "latest",
+    "langchain": "^1.2.0",
+    "less": "latest",
+    "lightningcss": "latest",
+    "linkedom": "^0.18.12",
+    "lucide-react": "^0.561.0",
+    "marked": "^17.0.1",
+    "mermaid": "^11.12.2",
+    "mongodb": "latest",
+    "motion": "^12.23.26",
+    "mysql2": "latest",
+    "next": "16.0.10",
+    "next-themes": "^0.4.6",
+    "pg": "latest",
+    "pinets": "^0.5.0",
+    "postgres": "latest",
+    "prisma": "latest",
+    "react": "19.2.3",
+    "react-day-picker": "9.12.0",
+    "react-dom": "19.2.3",
+    "react-hook-form": "^7.68.0",
+    "react-is": "^19.2.3",
+    "react-native": "latest",
+    "react-resizable-panels": "^3.0.6",
+    "react-router": "latest",
+    "rehype-katex": "^7.0.1",
+    "remark": "15.0.1",
+    "remark-gfm": "4.0.1",
+    "remark-math": "^6.0.0",
+    "remark-rehype": "11.1.2",
+    "resend": "^6.6.0",
+    "sass": "latest",
+    "sass-embedded": "latest",
+    "simplex-noise": "^4.0.3",
+    "siwe": "^3.0.0",
+    "solid-js": "latest",
+    "sonner": "^2.0.7",
+    "sql.js": "latest",
+    "sqlite3": "latest",
+    "stripe": "^20.0.0",
+    "stylus": "latest",
+    "sugarss": "latest",
+    "tailwind-merge": "^3.4.0",
+    "tailwindcss-animate": "^1.0.7",
+    "tavily": "^1.0.2",
+    "terser": "^5.44.1",
+    "three": "^0.182.0",
+    "three-globe": "^2.45.0",
+    "tsx": "latest",
+    "unist-util-visit": "5.0.0",
+    "valibot": "latest",
+    "vaul": "^1.1.2",
+    "viem": "^2.42.0",
+    "vitest": "latest",
+    "waku": "latest",
+    "yaml": "latest",
+    "zod": "4.1.13"
   },
-  "license": "MIT",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/OpenSourceAGI/GRAB-URL.git",
-    "directory": "packages/api2ai"
-  },
-  "bugs": {
-    "url": "https://github.com/OpenSourceAGI/GRAB-URL/issues"
+  "devDependencies": {
+    "@fumadocs/cli": "^1.1.0",
+    "@tailwindcss/postcss": "^4.1.18",
+    "@types/node": "^25.0.2",
+    "@types/react": "^19.2.7",
+    "@types/react-dom": "^19.2.3",
+    "@types/three": "^0.182.0",
+    "@vitest/coverage-v8": "^4.1.0",
+    "concurrently": "^9.2.1",
+    "drizzle-kit": "^0.31.8",
+    "opener": "^1.5.2",
+    "postcss": "^8.5.6",
+    "tailwindcss": "^4.1.18",
+    "tw-animate-css": "1.4.0",
+    "typescript": "^5.9.3",
+    "vite": "^7.3.0",
+    "vite-plugin-dts": "^4.5.4",
+    "vitest": "^4.1.0",
+    "wait-on": "^9.0.3"
   },
-  "homepage": "https://github.com/OpenSourceAGI/GRAB-URL/tree/master/packages/api2ai#readme",
-  "files": [
-    "src",
-    "README.md"
+  "data": "dist/index.d.ts",
+  "trustedDependencies": [
+    "pg-native"
   ]
 }