github-to-mcp-monorepo 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.env.example +8 -0
- package/.github/CODEOWNERS +6 -0
- package/.husky/pre-commit +1 -0
- package/.nvmrc +1 -0
- package/.prettierignore +5 -0
- package/.prettierrc +7 -0
- package/.vscode/settings.json +4 -0
- package/ARCHITECTURE.md +1429 -0
- package/CHANGELOG.md +167 -0
- package/CONTRIBUTING.md +327 -0
- package/LICENSE +201 -0
- package/README.md +1028 -0
- package/SECURITY.md +248 -0
- package/VISUAL_GUIDE.md +437 -0
- package/apps/vscode/IMPLEMENTATION.md +480 -0
- package/apps/vscode/README.md +248 -0
- package/apps/vscode/package.json +381 -0
- package/apps/vscode/resources/icon.png +0 -0
- package/apps/vscode/resources/icon.svg +5 -0
- package/apps/vscode/src/commands/browseRegistry.ts +211 -0
- package/apps/vscode/src/commands/configureClaudeDesktop.ts +332 -0
- package/apps/vscode/src/commands/convert.ts +82 -0
- package/apps/vscode/src/commands/convertCurrentRepo.ts +109 -0
- package/apps/vscode/src/commands/convertFromUrl.ts +138 -0
- package/apps/vscode/src/commands/index.ts +121 -0
- package/apps/vscode/src/commands/validate.ts +197 -0
- package/apps/vscode/src/extension.ts +464 -0
- package/apps/vscode/src/global.d.ts +36 -0
- package/apps/vscode/src/test/extension.test.ts +73 -0
- package/apps/vscode/src/utils/file-generator.ts +529 -0
- package/apps/vscode/src/utils/github-api.ts +335 -0
- package/apps/vscode/src/utils/index.ts +29 -0
- package/apps/vscode/src/utils/mcp-config.ts +334 -0
- package/apps/vscode/src/utils/storage.ts +87 -0
- package/apps/vscode/src/views/McpServersTreeView.ts +160 -0
- package/apps/vscode/src/views/OutputChannelView.ts +195 -0
- package/apps/vscode/src/views/StatusBarItem.ts +251 -0
- package/apps/vscode/src/views/ToolsExplorerView.ts +314 -0
- package/apps/vscode/src/views/historyProvider.ts +75 -0
- package/apps/vscode/src/views/index.ts +12 -0
- package/apps/vscode/src/views/resultsPanel.ts +330 -0
- package/apps/vscode/src/webviews/ConversionPanel.ts +350 -0
- package/apps/vscode/src/webviews/ToolDetailsPanel.ts +448 -0
- package/apps/vscode/src/webviews/index.ts +9 -0
- package/apps/vscode/src/webviews/webview-ui/styles.ts +492 -0
- package/apps/vscode/tsconfig.json +20 -0
- package/apps/web/PLAYGROUND_GUIDE.md +499 -0
- package/apps/web/README.md +505 -0
- package/apps/web/app/api/convert/route.ts +100 -0
- package/apps/web/app/api/convert/stream/route.ts +198 -0
- package/apps/web/app/api/deploy/route.ts +157 -0
- package/apps/web/app/api/edge/route.ts +308 -0
- package/apps/web/app/api/export-docker/route.ts +284 -0
- package/apps/web/app/api/generate-openapi/route.ts +119 -0
- package/apps/web/app/api/mcp/[serverId]/route.ts +263 -0
- package/apps/web/app/api/playground/connect/route.ts +143 -0
- package/apps/web/app/api/playground/disconnect/route.ts +78 -0
- package/apps/web/app/api/playground/execute/route.ts +135 -0
- package/apps/web/app/api/playground/sessions/route.ts +103 -0
- package/apps/web/app/api/playground/tools/route.ts +117 -0
- package/apps/web/app/api/playground/v2/connect/route.ts +96 -0
- package/apps/web/app/api/playground/v2/disconnect/route.ts +88 -0
- package/apps/web/app/api/playground/v2/health/route.ts +80 -0
- package/apps/web/app/api/playground/v2/prompts/route.ts +160 -0
- package/apps/web/app/api/playground/v2/resources/route.ts +159 -0
- package/apps/web/app/api/playground/v2/sessions/route.ts +184 -0
- package/apps/web/app/api/playground/v2/tools/route.ts +167 -0
- package/apps/web/app/api/stream/route.ts +232 -0
- package/apps/web/app/batch/BatchConvertClient.tsx +190 -0
- package/apps/web/app/batch/page.tsx +37 -0
- package/apps/web/app/convert/page.tsx +269 -0
- package/apps/web/app/dashboard/page.tsx +380 -0
- package/apps/web/app/globals.css +622 -0
- package/apps/web/app/layout.tsx +120 -0
- package/apps/web/app/manifest.ts +31 -0
- package/apps/web/app/opengraph-image.tsx +112 -0
- package/apps/web/app/page.old.tsx +924 -0
- package/apps/web/app/page.tsx +77 -0
- package/apps/web/app/playground/page.tsx +306 -0
- package/apps/web/app/playground/v2/error.tsx +163 -0
- package/apps/web/app/playground/v2/layout.tsx +58 -0
- package/apps/web/app/playground/v2/loading.tsx +152 -0
- package/apps/web/app/playground/v2/page.tsx +644 -0
- package/apps/web/app/playground/v2/providers.tsx +214 -0
- package/apps/web/app/playground/v2/use-shortcuts.ts +209 -0
- package/apps/web/app/playground/v2/use-url-state.ts +296 -0
- package/apps/web/app/providers.tsx +22 -0
- package/apps/web/app/sitemap.ts +32 -0
- package/apps/web/app/twitter-image.tsx +112 -0
- package/apps/web/components/BranchSelector.tsx +401 -0
- package/apps/web/components/ClaudeConfigExport.tsx +226 -0
- package/apps/web/components/Features.tsx +84 -0
- package/apps/web/components/Footer.tsx +119 -0
- package/apps/web/components/GenerationProgress.tsx +248 -0
- package/apps/web/components/GithubUrlInput.tsx +483 -0
- package/apps/web/components/Header.tsx +175 -0
- package/apps/web/components/Hero.tsx +117 -0
- package/apps/web/components/HowItWorks.tsx +119 -0
- package/apps/web/components/InstallBanner.tsx +158 -0
- package/apps/web/components/Logo.tsx +116 -0
- package/apps/web/components/ParticleBackground.tsx +105 -0
- package/apps/web/components/Playground.tsx +472 -0
- package/apps/web/components/PlaygroundToolTester.tsx +410 -0
- package/apps/web/components/ProductCards.tsx +179 -0
- package/apps/web/components/SplitView.tsx +194 -0
- package/apps/web/components/ToolFilter.tsx +260 -0
- package/apps/web/components/ToolList.tsx +325 -0
- package/apps/web/components/batch/BatchConvert.tsx +785 -0
- package/apps/web/components/batch/index.ts +7 -0
- package/apps/web/components/convert/ConfigTabs.tsx +230 -0
- package/apps/web/components/convert/ConversionResult.tsx +482 -0
- package/apps/web/components/convert/InlinePlayground.tsx +259 -0
- package/apps/web/components/convert/LoadingSteps.tsx +311 -0
- package/apps/web/components/convert/OneClickInstall.tsx +224 -0
- package/apps/web/components/convert/ToolCard.tsx +189 -0
- package/apps/web/components/convert/TryInPlayground.tsx +242 -0
- package/apps/web/components/convert/index.ts +12 -0
- package/apps/web/components/deploy/DeployButton.tsx +369 -0
- package/apps/web/components/deploy/index.ts +7 -0
- package/apps/web/components/docker/DockerExport.tsx +690 -0
- package/apps/web/components/docker/index.ts +7 -0
- package/apps/web/components/install/OneClickInstall.tsx +676 -0
- package/apps/web/components/install/index.ts +7 -0
- package/apps/web/components/playground/CapabilityTabs.tsx +150 -0
- package/apps/web/components/playground/ConnectionStatusV2.tsx +322 -0
- package/apps/web/components/playground/EmptyStates.tsx +305 -0
- package/apps/web/components/playground/ExecutionLog.tsx +260 -0
- package/apps/web/components/playground/ExecutionLogV2.tsx +378 -0
- package/apps/web/components/playground/JsonViewer.tsx +388 -0
- package/apps/web/components/playground/PlaygroundLayout.tsx +244 -0
- package/apps/web/components/playground/PromptsPanel.tsx +385 -0
- package/apps/web/components/playground/ResourcesPanel.tsx +378 -0
- package/apps/web/components/playground/SchemaForm.tsx +477 -0
- package/apps/web/components/playground/ServerStatus.tsx +151 -0
- package/apps/web/components/playground/ShareButton.tsx +239 -0
- package/apps/web/components/playground/ToolsPanel.tsx +309 -0
- package/apps/web/components/playground/TransportConfigurator.tsx +563 -0
- package/apps/web/components/playground/index.ts +74 -0
- package/apps/web/components/playground/types.ts +202 -0
- package/apps/web/components/streaming/StreamingProgress.tsx +441 -0
- package/apps/web/components/streaming/index.ts +7 -0
- package/apps/web/components/ui/badge.tsx +42 -0
- package/apps/web/components/ui/button.tsx +88 -0
- package/apps/web/components/ui/card.tsx +75 -0
- package/apps/web/components/ui/code-block.tsx +122 -0
- package/apps/web/components/ui/index.ts +12 -0
- package/apps/web/components/ui/input.tsx +55 -0
- package/apps/web/components/ui/tabs.tsx +61 -0
- package/apps/web/hooks/index.ts +85 -0
- package/apps/web/hooks/types.ts +1173 -0
- package/apps/web/hooks/use-conversion.ts +133 -0
- package/apps/web/hooks/use-execution-history.ts +376 -0
- package/apps/web/hooks/use-generation-progress.ts +147 -0
- package/apps/web/hooks/use-local-storage.ts +88 -0
- package/apps/web/hooks/use-mcp-client.ts +623 -0
- package/apps/web/hooks/use-mcp-connection.ts +500 -0
- package/apps/web/hooks/use-mcp-execution.ts +282 -0
- package/apps/web/hooks/use-mcp-prompts.ts +441 -0
- package/apps/web/hooks/use-mcp-resources.ts +430 -0
- package/apps/web/hooks/use-mcp-tools.ts +540 -0
- package/apps/web/hooks/use-playground-store.ts +299 -0
- package/apps/web/hooks/use-playground.ts +184 -0
- package/apps/web/hooks/use-streaming-conversion.ts +227 -0
- package/apps/web/hooks/useBatchConversion.ts +271 -0
- package/apps/web/hooks/useDockerConfig.ts +161 -0
- package/apps/web/hooks/usePlatformDetection.ts +80 -0
- package/apps/web/hooks/useStreaming.ts +199 -0
- package/apps/web/lib/api/errors.ts +386 -0
- package/apps/web/lib/api/index.ts +137 -0
- package/apps/web/lib/api/logger.ts +187 -0
- package/apps/web/lib/api/middleware.ts +364 -0
- package/apps/web/lib/api/openapi.ts +977 -0
- package/apps/web/lib/api/session-manager.ts +594 -0
- package/apps/web/lib/api/types.ts +433 -0
- package/apps/web/lib/api/validation.ts +523 -0
- package/apps/web/lib/constants.ts +114 -0
- package/apps/web/lib/mcp/client.ts +1137 -0
- package/apps/web/lib/mcp/events.ts +651 -0
- package/apps/web/lib/mcp/index.ts +347 -0
- package/apps/web/lib/mcp/logger.ts +428 -0
- package/apps/web/lib/mcp/metrics.ts +703 -0
- package/apps/web/lib/mcp/retry.ts +616 -0
- package/apps/web/lib/mcp/session-manager.ts +779 -0
- package/apps/web/lib/mcp/transports.ts +988 -0
- package/apps/web/lib/mcp/types.ts +594 -0
- package/apps/web/lib/mcp-client-enhanced.ts +871 -0
- package/apps/web/lib/mcp-client.ts +778 -0
- package/apps/web/lib/mcp-errors.ts +489 -0
- package/apps/web/lib/mcp-sandbox.ts +593 -0
- package/apps/web/lib/mcp-testing.ts +428 -0
- package/apps/web/lib/mcp-types.ts +448 -0
- package/apps/web/lib/playground-store.tsx +1147 -0
- package/apps/web/lib/utils.ts +439 -0
- package/apps/web/next-env.d.ts +5 -0
- package/apps/web/next.config.js +23 -0
- package/apps/web/package.json +55 -0
- package/apps/web/postcss.config.js +6 -0
- package/apps/web/public/.well-known/ai-plugin.json +17 -0
- package/apps/web/public/logo.svg +6 -0
- package/apps/web/public/robots.txt +22 -0
- package/apps/web/public/schema.json +27 -0
- package/apps/web/tailwind.config.js +26 -0
- package/apps/web/tailwind.config.ts +123 -0
- package/apps/web/tsconfig.json +20 -0
- package/apps/web/types/deploy.ts +139 -0
- package/apps/web/types/index.ts +247 -0
- package/apps/web/vercel.json +39 -0
- package/eslint.config.mjs +23 -0
- package/llms.txt +102 -0
- package/mkdocs/docs/api/core.md +318 -0
- package/mkdocs/docs/api/index.md +128 -0
- package/mkdocs/docs/api/mcp-server.md +301 -0
- package/mkdocs/docs/api/openapi-parser.md +254 -0
- package/mkdocs/docs/assets/logo.svg +7 -0
- package/mkdocs/docs/changelog.md +118 -0
- package/mkdocs/docs/cli/generate.md +148 -0
- package/mkdocs/docs/cli/index.md +52 -0
- package/mkdocs/docs/cli/inspect.md +164 -0
- package/mkdocs/docs/cli/serve.md +136 -0
- package/mkdocs/docs/concepts/classification.md +254 -0
- package/mkdocs/docs/concepts/how-it-works.md +299 -0
- package/mkdocs/docs/concepts/index.md +77 -0
- package/mkdocs/docs/concepts/mcp-protocol.md +362 -0
- package/mkdocs/docs/concepts/tool-types.md +382 -0
- package/mkdocs/docs/contributing/architecture.md +262 -0
- package/mkdocs/docs/contributing/development.md +245 -0
- package/mkdocs/docs/contributing/index.md +73 -0
- package/mkdocs/docs/contributing/testing.md +320 -0
- package/mkdocs/docs/getting-started/configuration.md +235 -0
- package/mkdocs/docs/getting-started/index.md +54 -0
- package/mkdocs/docs/getting-started/installation.md +145 -0
- package/mkdocs/docs/getting-started/quickstart.md +160 -0
- package/mkdocs/docs/guides/batch.md +375 -0
- package/mkdocs/docs/guides/claude-desktop.md +227 -0
- package/mkdocs/docs/guides/cursor.md +188 -0
- package/mkdocs/docs/guides/custom-tools.md +367 -0
- package/mkdocs/docs/guides/index.md +78 -0
- package/mkdocs/docs/guides/private-repos.md +221 -0
- package/mkdocs/docs/guides/vscode.md +247 -0
- package/mkdocs/docs/index.md +175 -0
- package/mkdocs/docs/reference/config.md +223 -0
- package/mkdocs/docs/reference/env.md +192 -0
- package/mkdocs/docs/reference/index.md +102 -0
- package/mkdocs/docs/reference/tools.md +309 -0
- package/mkdocs/docs/stylesheets/extra.css +231 -0
- package/mkdocs/mkdocs.yml +204 -0
- package/mkdocs/overrides/.gitkeep +1 -0
- package/mkdocs/overrides/main.html +7 -0
- package/mkdocs/python-deps.txt +7 -0
- package/mkdocs/vercel.json +11 -0
- package/package.json +63 -0
- package/packages/core/package.json +61 -0
- package/packages/core/src/__tests__/bitbucket-client.test.ts +366 -0
- package/packages/core/src/__tests__/cli.test.ts +235 -0
- package/packages/core/src/__tests__/code-extractor.test.ts +378 -0
- package/packages/core/src/__tests__/docker-generator.test.ts +255 -0
- package/packages/core/src/__tests__/github-client.test.ts +390 -0
- package/packages/core/src/__tests__/gitlab-client.test.ts +319 -0
- package/packages/core/src/__tests__/go-extractor.test.ts +351 -0
- package/packages/core/src/__tests__/graphql-extractor.test.ts +330 -0
- package/packages/core/src/__tests__/java-extractor.test.ts +497 -0
- package/packages/core/src/__tests__/plugins.test.ts +467 -0
- package/packages/core/src/__tests__/readme-extractor.test.ts +258 -0
- package/packages/core/src/__tests__/redis-cache.test.ts +307 -0
- package/packages/core/src/__tests__/rust-extractor.test.ts +252 -0
- package/packages/core/src/__tests__/streaming.test.ts +251 -0
- package/packages/core/src/additional-extractors.ts +333 -0
- package/packages/core/src/cache/cache-interface.ts +179 -0
- package/packages/core/src/cache/index.ts +210 -0
- package/packages/core/src/cache/redis-cache.ts +291 -0
- package/packages/core/src/cache/upstash-cache.ts +379 -0
- package/packages/core/src/cache.ts +251 -0
- package/packages/core/src/cli.ts +822 -0
- package/packages/core/src/code-extractor.ts +696 -0
- package/packages/core/src/docker-generator.ts +470 -0
- package/packages/core/src/edge-compatible.ts +491 -0
- package/packages/core/src/extractors/go-extractor.ts +791 -0
- package/packages/core/src/extractors/index.ts +9 -0
- package/packages/core/src/extractors/java-extractor.ts +937 -0
- package/packages/core/src/extractors/rust-extractor.ts +744 -0
- package/packages/core/src/github-client.ts +319 -0
- package/packages/core/src/go-generator.ts +356 -0
- package/packages/core/src/graphql-extractor.ts +358 -0
- package/packages/core/src/index.ts +797 -0
- package/packages/core/src/langchain-exporter.ts +617 -0
- package/packages/core/src/language-parsers.ts +1114 -0
- package/packages/core/src/mcp-introspector.ts +279 -0
- package/packages/core/src/monorepo-detector.ts +378 -0
- package/packages/core/src/plugins/index.ts +370 -0
- package/packages/core/src/plugins/registry.ts +404 -0
- package/packages/core/src/plugins/types.ts +215 -0
- package/packages/core/src/providers/base-provider.ts +246 -0
- package/packages/core/src/providers/bitbucket-client.ts +464 -0
- package/packages/core/src/providers/gitlab-client.ts +388 -0
- package/packages/core/src/providers/index.ts +176 -0
- package/packages/core/src/python-generator.ts +260 -0
- package/packages/core/src/queue/index.ts +100 -0
- package/packages/core/src/queue/memory-queue.ts +445 -0
- package/packages/core/src/queue/redis-queue.ts +578 -0
- package/packages/core/src/queue/types.ts +251 -0
- package/packages/core/src/readme-extractor.ts +409 -0
- package/packages/core/src/schema-generator.ts +638 -0
- package/packages/core/src/streaming.ts +999 -0
- package/packages/core/src/types.ts +289 -0
- package/packages/core/tsconfig.json +9 -0
- package/packages/core/tsup.config.ts +25 -0
- package/packages/mcp-server/README.md +297 -0
- package/packages/mcp-server/package.json +55 -0
- package/packages/mcp-server/src/__tests__/mcp-server.test.ts +177 -0
- package/packages/mcp-server/src/__tests__/tools.test.ts +217 -0
- package/packages/mcp-server/src/index.ts +1206 -0
- package/packages/mcp-server/src/prompts/index.ts +601 -0
- package/packages/mcp-server/src/tools/export-docker.ts +362 -0
- package/packages/mcp-server/src/tools/generate-openapi.ts +162 -0
- package/packages/mcp-server/src/tools/monitor-mcp-server.ts +448 -0
- package/packages/mcp-server/src/tools/stream-convert.ts +398 -0
- package/packages/mcp-server/src/tools/test-mcp-tool.ts +531 -0
- package/packages/mcp-server/tsconfig.json +12 -0
- package/packages/mcp-server/tsup.config.ts +14 -0
- package/packages/openapi-parser/package-lock.json +3028 -0
- package/packages/openapi-parser/package.json +41 -0
- package/packages/openapi-parser/src/analyzer.ts +700 -0
- package/packages/openapi-parser/src/asyncapi-parser.ts +475 -0
- package/packages/openapi-parser/src/cli.ts +302 -0
- package/packages/openapi-parser/src/generator.ts +570 -0
- package/packages/openapi-parser/src/generators/express-analyzer.ts +649 -0
- package/packages/openapi-parser/src/generators/fastapi-analyzer.ts +960 -0
- package/packages/openapi-parser/src/generators/index.ts +200 -0
- package/packages/openapi-parser/src/generators/nextjs-analyzer.ts +768 -0
- package/packages/openapi-parser/src/generators/openapi-builder.ts +527 -0
- package/packages/openapi-parser/src/generators/types.ts +298 -0
- package/packages/openapi-parser/src/graphql-parser.ts +462 -0
- package/packages/openapi-parser/src/grpc-parser.ts +649 -0
- package/packages/openapi-parser/src/har-parser.ts +723 -0
- package/packages/openapi-parser/src/index.ts +635 -0
- package/packages/openapi-parser/src/insomnia-parser.ts +614 -0
- package/packages/openapi-parser/src/parser.ts +231 -0
- package/packages/openapi-parser/src/postman-parser.ts +611 -0
- package/packages/openapi-parser/src/ref-resolver.ts +313 -0
- package/packages/openapi-parser/src/transformer.ts +459 -0
- package/packages/openapi-parser/tests/generators/express.test.ts +209 -0
- package/packages/openapi-parser/tests/generators/fastapi.test.ts +236 -0
- package/packages/openapi-parser/tests/generators/nextjs.test.ts +273 -0
- package/packages/openapi-parser/tests/parsers.test.ts +847 -0
- package/packages/openapi-parser/tsconfig.json +9 -0
- package/packages/openapi-parser/tsup.config.ts +11 -0
- package/packages/registry/package.json +59 -0
- package/packages/registry/src/cli.ts +456 -0
- package/packages/registry/src/index.ts +44 -0
- package/packages/registry/src/popular/github.json +47 -0
- package/packages/registry/src/popular/index.ts +55 -0
- package/packages/registry/src/popular/linear.json +42 -0
- package/packages/registry/src/popular/notion.json +42 -0
- package/packages/registry/src/popular/openai.json +40 -0
- package/packages/registry/src/popular/resend.json +38 -0
- package/packages/registry/src/popular/slack.json +42 -0
- package/packages/registry/src/popular/stripe.json +163 -0
- package/packages/registry/src/popular/supabase.json +42 -0
- package/packages/registry/src/popular/twilio.json +40 -0
- package/packages/registry/src/popular/vercel.json +40 -0
- package/packages/registry/src/registry.ts +492 -0
- package/packages/registry/src/storage.ts +334 -0
- package/packages/registry/src/types.ts +275 -0
- package/packages/registry/src/updater.ts +208 -0
- package/packages/registry/tsconfig.json +10 -0
- package/packages/registry/tsup.config.ts +11 -0
- package/pnpm-workspace.yaml +3 -0
- package/scripts/build-docs.sh +16 -0
- package/server.json +9 -0
- package/templates/Dockerfile.python.template +60 -0
- package/templates/Dockerfile.typescript.template +60 -0
- package/templates/docker-compose.template.yml +68 -0
- package/tests/fixtures/express-app/index.js +34 -0
- package/tests/fixtures/express-app/routes/posts.js +43 -0
- package/tests/fixtures/express-app/routes/users.js +58 -0
- package/tests/fixtures/fastapi-app/main.py +125 -0
- package/tests/fixtures/fastapi-app/routes/admin.py +42 -0
- package/tests/fixtures/graphql/simple-schema.graphql +65 -0
- package/tests/fixtures/mocks/github-api-responses.json +63 -0
- package/tests/fixtures/nextjs-app/app/api/posts/route.ts +55 -0
- package/tests/fixtures/nextjs-app/app/api/users/[id]/route.ts +63 -0
- package/tests/fixtures/nextjs-app/app/api/users/route.ts +44 -0
- package/tests/fixtures/nextjs-app/pages/api/health.ts +28 -0
- package/tests/fixtures/openapi/petstore.yaml +179 -0
- package/tests/integration/langchain-export.test.ts +405 -0
- package/tests/integration/openapi-conversion.test.ts +221 -0
- package/tsconfig.json +18 -0
- package/vitest.config.ts +32 -0
|
@@ -0,0 +1,977 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* OpenAPI Documentation for Playground API v2
|
|
3
|
+
*
|
|
4
|
+
* This module provides OpenAPI 3.1 specification for the playground API.
|
|
5
|
+
*/
|
|
6
|
+
|
|
7
|
+
// OpenAPI 3.1 Document type (simplified definition to avoid external dependency)
|
|
8
|
+
interface OpenAPIDocument {
|
|
9
|
+
openapi: string;
|
|
10
|
+
info: {
|
|
11
|
+
title: string;
|
|
12
|
+
description: string;
|
|
13
|
+
version: string;
|
|
14
|
+
contact?: {
|
|
15
|
+
name?: string;
|
|
16
|
+
url?: string;
|
|
17
|
+
email?: string;
|
|
18
|
+
};
|
|
19
|
+
license?: {
|
|
20
|
+
name: string;
|
|
21
|
+
url?: string;
|
|
22
|
+
};
|
|
23
|
+
};
|
|
24
|
+
servers?: Array<{
|
|
25
|
+
url: string;
|
|
26
|
+
description?: string;
|
|
27
|
+
}>;
|
|
28
|
+
tags?: Array<{
|
|
29
|
+
name: string;
|
|
30
|
+
description?: string;
|
|
31
|
+
}>;
|
|
32
|
+
paths: Record<string, unknown>;
|
|
33
|
+
components?: {
|
|
34
|
+
schemas?: Record<string, unknown>;
|
|
35
|
+
securitySchemes?: Record<string, unknown>;
|
|
36
|
+
parameters?: Record<string, unknown>;
|
|
37
|
+
requestBodies?: Record<string, unknown>;
|
|
38
|
+
responses?: Record<string, unknown>;
|
|
39
|
+
};
|
|
40
|
+
}
|
|
41
|
+
|
|
42
|
+
export const openApiSpec: OpenAPIDocument = {
|
|
43
|
+
openapi: '3.1.0',
|
|
44
|
+
info: {
|
|
45
|
+
title: 'MCP Playground API',
|
|
46
|
+
description: `
|
|
47
|
+
The MCP Playground API provides endpoints for connecting to and interacting with
|
|
48
|
+
Model Context Protocol (MCP) servers. It supports multiple transport types including
|
|
49
|
+
stdio, SSE, and HTTP.
|
|
50
|
+
|
|
51
|
+
## Features
|
|
52
|
+
|
|
53
|
+
- **Session Management**: Create, list, and delete MCP server sessions
|
|
54
|
+
- **Tool Execution**: Discover and execute MCP tools
|
|
55
|
+
- **Resource Access**: Browse and read MCP resources
|
|
56
|
+
- **Prompt Templates**: Use and customize MCP prompts
|
|
57
|
+
- **Health Monitoring**: Check API health and session status
|
|
58
|
+
|
|
59
|
+
## Rate Limiting
|
|
60
|
+
|
|
61
|
+
All endpoints are rate-limited. Check the following headers in responses:
|
|
62
|
+
- \`X-RateLimit-Limit\`: Maximum requests per window
|
|
63
|
+
- \`X-RateLimit-Remaining\`: Remaining requests in current window
|
|
64
|
+
- \`X-RateLimit-Reset\`: Seconds until the window resets
|
|
65
|
+
|
|
66
|
+
## Request Tracking
|
|
67
|
+
|
|
68
|
+
All requests include an \`X-Request-ID\` header for tracing. You can provide your own
|
|
69
|
+
request ID or let the server generate one.
|
|
70
|
+
`,
|
|
71
|
+
version: '2.0.0',
|
|
72
|
+
contact: {
|
|
73
|
+
name: 'MCP Playground Support',
|
|
74
|
+
url: 'https://github.com/nirholas/github-to-mcp',
|
|
75
|
+
},
|
|
76
|
+
license: {
|
|
77
|
+
name: 'MIT',
|
|
78
|
+
url: 'https://opensource.org/licenses/MIT',
|
|
79
|
+
},
|
|
80
|
+
},
|
|
81
|
+
servers: [
|
|
82
|
+
{
|
|
83
|
+
url: '/api/playground/v2',
|
|
84
|
+
description: 'Playground API v2',
|
|
85
|
+
},
|
|
86
|
+
],
|
|
87
|
+
tags: [
|
|
88
|
+
{ name: 'Connection', description: 'Session connection management' },
|
|
89
|
+
{ name: 'Tools', description: 'MCP tool discovery and execution' },
|
|
90
|
+
{ name: 'Resources', description: 'MCP resource browsing and reading' },
|
|
91
|
+
{ name: 'Prompts', description: 'MCP prompt discovery and execution' },
|
|
92
|
+
{ name: 'Sessions', description: 'Session management' },
|
|
93
|
+
{ name: 'Health', description: 'Health and status monitoring' },
|
|
94
|
+
],
|
|
95
|
+
paths: {
|
|
96
|
+
'/connect': {
|
|
97
|
+
post: {
|
|
98
|
+
tags: ['Connection'],
|
|
99
|
+
summary: 'Connect to MCP server',
|
|
100
|
+
description: 'Establishes a new connection to an MCP server using the specified transport configuration.',
|
|
101
|
+
operationId: 'connect',
|
|
102
|
+
requestBody: {
|
|
103
|
+
required: true,
|
|
104
|
+
content: {
|
|
105
|
+
'application/json': {
|
|
106
|
+
schema: { $ref: '#/components/schemas/ConnectRequest' },
|
|
107
|
+
examples: {
|
|
108
|
+
stdio: {
|
|
109
|
+
summary: 'Stdio transport',
|
|
110
|
+
value: {
|
|
111
|
+
transport: {
|
|
112
|
+
type: 'stdio',
|
|
113
|
+
command: 'npx',
|
|
114
|
+
args: ['-y', '@modelcontextprotocol/server-filesystem', '/tmp'],
|
|
115
|
+
},
|
|
116
|
+
},
|
|
117
|
+
},
|
|
118
|
+
sse: {
|
|
119
|
+
summary: 'SSE transport',
|
|
120
|
+
value: {
|
|
121
|
+
transport: {
|
|
122
|
+
type: 'sse',
|
|
123
|
+
url: 'http://localhost:3001/sse',
|
|
124
|
+
},
|
|
125
|
+
},
|
|
126
|
+
},
|
|
127
|
+
http: {
|
|
128
|
+
summary: 'HTTP transport',
|
|
129
|
+
value: {
|
|
130
|
+
transport: {
|
|
131
|
+
type: 'http',
|
|
132
|
+
url: 'http://localhost:3001/mcp',
|
|
133
|
+
},
|
|
134
|
+
},
|
|
135
|
+
},
|
|
136
|
+
},
|
|
137
|
+
},
|
|
138
|
+
},
|
|
139
|
+
},
|
|
140
|
+
responses: {
|
|
141
|
+
'200': {
|
|
142
|
+
description: 'Successfully connected',
|
|
143
|
+
content: {
|
|
144
|
+
'application/json': {
|
|
145
|
+
schema: { $ref: '#/components/schemas/ConnectResponse' },
|
|
146
|
+
},
|
|
147
|
+
},
|
|
148
|
+
},
|
|
149
|
+
'400': { $ref: '#/components/responses/ValidationError' },
|
|
150
|
+
'429': { $ref: '#/components/responses/RateLimitError' },
|
|
151
|
+
'502': { $ref: '#/components/responses/ConnectionError' },
|
|
152
|
+
},
|
|
153
|
+
},
|
|
154
|
+
options: {
|
|
155
|
+
tags: ['Connection'],
|
|
156
|
+
summary: 'CORS preflight',
|
|
157
|
+
responses: { '204': { description: 'CORS preflight response' } },
|
|
158
|
+
},
|
|
159
|
+
},
|
|
160
|
+
'/disconnect': {
|
|
161
|
+
post: {
|
|
162
|
+
tags: ['Connection'],
|
|
163
|
+
summary: 'Disconnect from MCP server',
|
|
164
|
+
description: 'Closes an existing MCP server connection and cleans up the session.',
|
|
165
|
+
operationId: 'disconnect',
|
|
166
|
+
requestBody: {
|
|
167
|
+
required: true,
|
|
168
|
+
content: {
|
|
169
|
+
'application/json': {
|
|
170
|
+
schema: { $ref: '#/components/schemas/DisconnectRequest' },
|
|
171
|
+
},
|
|
172
|
+
},
|
|
173
|
+
},
|
|
174
|
+
responses: {
|
|
175
|
+
'200': {
|
|
176
|
+
description: 'Successfully disconnected',
|
|
177
|
+
content: {
|
|
178
|
+
'application/json': {
|
|
179
|
+
schema: { $ref: '#/components/schemas/DisconnectResponse' },
|
|
180
|
+
},
|
|
181
|
+
},
|
|
182
|
+
},
|
|
183
|
+
'400': { $ref: '#/components/responses/ValidationError' },
|
|
184
|
+
'410': { $ref: '#/components/responses/SessionExpiredError' },
|
|
185
|
+
'429': { $ref: '#/components/responses/RateLimitError' },
|
|
186
|
+
},
|
|
187
|
+
},
|
|
188
|
+
},
|
|
189
|
+
'/tools': {
|
|
190
|
+
get: {
|
|
191
|
+
tags: ['Tools'],
|
|
192
|
+
summary: 'List available tools',
|
|
193
|
+
description: 'Returns a list of all tools available from the connected MCP server.',
|
|
194
|
+
operationId: 'listTools',
|
|
195
|
+
parameters: [{ $ref: '#/components/parameters/SessionId' }],
|
|
196
|
+
responses: {
|
|
197
|
+
'200': {
|
|
198
|
+
description: 'List of tools',
|
|
199
|
+
content: {
|
|
200
|
+
'application/json': {
|
|
201
|
+
schema: { $ref: '#/components/schemas/ToolsListResponse' },
|
|
202
|
+
},
|
|
203
|
+
},
|
|
204
|
+
},
|
|
205
|
+
'400': { $ref: '#/components/responses/ValidationError' },
|
|
206
|
+
'410': { $ref: '#/components/responses/SessionExpiredError' },
|
|
207
|
+
'429': { $ref: '#/components/responses/RateLimitError' },
|
|
208
|
+
},
|
|
209
|
+
},
|
|
210
|
+
post: {
|
|
211
|
+
tags: ['Tools'],
|
|
212
|
+
summary: 'Execute a tool',
|
|
213
|
+
description: 'Executes a tool with the provided parameters and returns the result.',
|
|
214
|
+
operationId: 'executeTool',
|
|
215
|
+
requestBody: {
|
|
216
|
+
required: true,
|
|
217
|
+
content: {
|
|
218
|
+
'application/json': {
|
|
219
|
+
schema: { $ref: '#/components/schemas/ToolCallRequest' },
|
|
220
|
+
examples: {
|
|
221
|
+
echo: {
|
|
222
|
+
summary: 'Echo tool',
|
|
223
|
+
value: {
|
|
224
|
+
sessionId: 'session_123',
|
|
225
|
+
toolName: 'echo',
|
|
226
|
+
params: { message: 'Hello, World!' },
|
|
227
|
+
},
|
|
228
|
+
},
|
|
229
|
+
add: {
|
|
230
|
+
summary: 'Add tool',
|
|
231
|
+
value: {
|
|
232
|
+
sessionId: 'session_123',
|
|
233
|
+
toolName: 'add',
|
|
234
|
+
params: { a: 5, b: 3 },
|
|
235
|
+
},
|
|
236
|
+
},
|
|
237
|
+
},
|
|
238
|
+
},
|
|
239
|
+
},
|
|
240
|
+
},
|
|
241
|
+
responses: {
|
|
242
|
+
'200': {
|
|
243
|
+
description: 'Tool execution result',
|
|
244
|
+
content: {
|
|
245
|
+
'application/json': {
|
|
246
|
+
schema: { $ref: '#/components/schemas/ToolCallResponse' },
|
|
247
|
+
},
|
|
248
|
+
},
|
|
249
|
+
},
|
|
250
|
+
'400': { $ref: '#/components/responses/ValidationError' },
|
|
251
|
+
'404': { $ref: '#/components/responses/NotFoundError' },
|
|
252
|
+
'410': { $ref: '#/components/responses/SessionExpiredError' },
|
|
253
|
+
'422': { $ref: '#/components/responses/ExecutionError' },
|
|
254
|
+
'429': { $ref: '#/components/responses/RateLimitError' },
|
|
255
|
+
},
|
|
256
|
+
},
|
|
257
|
+
},
|
|
258
|
+
'/resources': {
|
|
259
|
+
get: {
|
|
260
|
+
tags: ['Resources'],
|
|
261
|
+
summary: 'List available resources',
|
|
262
|
+
description: 'Returns a list of all resources and resource templates available from the MCP server.',
|
|
263
|
+
operationId: 'listResources',
|
|
264
|
+
parameters: [{ $ref: '#/components/parameters/SessionId' }],
|
|
265
|
+
responses: {
|
|
266
|
+
'200': {
|
|
267
|
+
description: 'List of resources',
|
|
268
|
+
content: {
|
|
269
|
+
'application/json': {
|
|
270
|
+
schema: { $ref: '#/components/schemas/ResourcesListResponse' },
|
|
271
|
+
},
|
|
272
|
+
},
|
|
273
|
+
},
|
|
274
|
+
'400': { $ref: '#/components/responses/ValidationError' },
|
|
275
|
+
'410': { $ref: '#/components/responses/SessionExpiredError' },
|
|
276
|
+
'429': { $ref: '#/components/responses/RateLimitError' },
|
|
277
|
+
},
|
|
278
|
+
},
|
|
279
|
+
post: {
|
|
280
|
+
tags: ['Resources'],
|
|
281
|
+
summary: 'Read a resource',
|
|
282
|
+
description: 'Reads the contents of a resource identified by its URI.',
|
|
283
|
+
operationId: 'readResource',
|
|
284
|
+
requestBody: {
|
|
285
|
+
required: true,
|
|
286
|
+
content: {
|
|
287
|
+
'application/json': {
|
|
288
|
+
schema: { $ref: '#/components/schemas/ResourceReadRequest' },
|
|
289
|
+
},
|
|
290
|
+
},
|
|
291
|
+
},
|
|
292
|
+
responses: {
|
|
293
|
+
'200': {
|
|
294
|
+
description: 'Resource contents',
|
|
295
|
+
content: {
|
|
296
|
+
'application/json': {
|
|
297
|
+
schema: { $ref: '#/components/schemas/ResourceReadResponse' },
|
|
298
|
+
},
|
|
299
|
+
},
|
|
300
|
+
},
|
|
301
|
+
'400': { $ref: '#/components/responses/ValidationError' },
|
|
302
|
+
'404': { $ref: '#/components/responses/NotFoundError' },
|
|
303
|
+
'410': { $ref: '#/components/responses/SessionExpiredError' },
|
|
304
|
+
'422': { $ref: '#/components/responses/ExecutionError' },
|
|
305
|
+
'429': { $ref: '#/components/responses/RateLimitError' },
|
|
306
|
+
},
|
|
307
|
+
},
|
|
308
|
+
},
|
|
309
|
+
'/prompts': {
|
|
310
|
+
get: {
|
|
311
|
+
tags: ['Prompts'],
|
|
312
|
+
summary: 'List available prompts',
|
|
313
|
+
description: 'Returns a list of all prompts available from the MCP server.',
|
|
314
|
+
operationId: 'listPrompts',
|
|
315
|
+
parameters: [{ $ref: '#/components/parameters/SessionId' }],
|
|
316
|
+
responses: {
|
|
317
|
+
'200': {
|
|
318
|
+
description: 'List of prompts',
|
|
319
|
+
content: {
|
|
320
|
+
'application/json': {
|
|
321
|
+
schema: { $ref: '#/components/schemas/PromptsListResponse' },
|
|
322
|
+
},
|
|
323
|
+
},
|
|
324
|
+
},
|
|
325
|
+
'400': { $ref: '#/components/responses/ValidationError' },
|
|
326
|
+
'410': { $ref: '#/components/responses/SessionExpiredError' },
|
|
327
|
+
'429': { $ref: '#/components/responses/RateLimitError' },
|
|
328
|
+
},
|
|
329
|
+
},
|
|
330
|
+
post: {
|
|
331
|
+
tags: ['Prompts'],
|
|
332
|
+
summary: 'Get a prompt',
|
|
333
|
+
description: 'Gets a prompt with the provided arguments rendered into messages.',
|
|
334
|
+
operationId: 'getPrompt',
|
|
335
|
+
requestBody: {
|
|
336
|
+
required: true,
|
|
337
|
+
content: {
|
|
338
|
+
'application/json': {
|
|
339
|
+
schema: { $ref: '#/components/schemas/PromptGetRequest' },
|
|
340
|
+
},
|
|
341
|
+
},
|
|
342
|
+
},
|
|
343
|
+
responses: {
|
|
344
|
+
'200': {
|
|
345
|
+
description: 'Prompt messages',
|
|
346
|
+
content: {
|
|
347
|
+
'application/json': {
|
|
348
|
+
schema: { $ref: '#/components/schemas/PromptGetResponse' },
|
|
349
|
+
},
|
|
350
|
+
},
|
|
351
|
+
},
|
|
352
|
+
'400': { $ref: '#/components/responses/ValidationError' },
|
|
353
|
+
'404': { $ref: '#/components/responses/NotFoundError' },
|
|
354
|
+
'410': { $ref: '#/components/responses/SessionExpiredError' },
|
|
355
|
+
'422': { $ref: '#/components/responses/ExecutionError' },
|
|
356
|
+
'429': { $ref: '#/components/responses/RateLimitError' },
|
|
357
|
+
},
|
|
358
|
+
},
|
|
359
|
+
},
|
|
360
|
+
'/sessions': {
|
|
361
|
+
get: {
|
|
362
|
+
tags: ['Sessions'],
|
|
363
|
+
summary: 'List all sessions',
|
|
364
|
+
description: 'Returns a list of all active sessions.',
|
|
365
|
+
operationId: 'listSessions',
|
|
366
|
+
responses: {
|
|
367
|
+
'200': {
|
|
368
|
+
description: 'List of sessions',
|
|
369
|
+
content: {
|
|
370
|
+
'application/json': {
|
|
371
|
+
schema: { $ref: '#/components/schemas/SessionsListResponse' },
|
|
372
|
+
},
|
|
373
|
+
},
|
|
374
|
+
},
|
|
375
|
+
'429': { $ref: '#/components/responses/RateLimitError' },
|
|
376
|
+
},
|
|
377
|
+
},
|
|
378
|
+
delete: {
|
|
379
|
+
tags: ['Sessions'],
|
|
380
|
+
summary: 'Delete sessions',
|
|
381
|
+
description: 'Deletes one or all sessions. If sessionId is provided, deletes that session. Otherwise, deletes all sessions.',
|
|
382
|
+
operationId: 'deleteSessions',
|
|
383
|
+
requestBody: {
|
|
384
|
+
content: {
|
|
385
|
+
'application/json': {
|
|
386
|
+
schema: { $ref: '#/components/schemas/SessionsDeleteRequest' },
|
|
387
|
+
},
|
|
388
|
+
},
|
|
389
|
+
},
|
|
390
|
+
responses: {
|
|
391
|
+
'200': {
|
|
392
|
+
description: 'Deletion result',
|
|
393
|
+
content: {
|
|
394
|
+
'application/json': {
|
|
395
|
+
schema: { $ref: '#/components/schemas/SessionsDeleteResponse' },
|
|
396
|
+
},
|
|
397
|
+
},
|
|
398
|
+
},
|
|
399
|
+
'400': { $ref: '#/components/responses/ValidationError' },
|
|
400
|
+
'429': { $ref: '#/components/responses/RateLimitError' },
|
|
401
|
+
},
|
|
402
|
+
},
|
|
403
|
+
},
|
|
404
|
+
'/health': {
|
|
405
|
+
get: {
|
|
406
|
+
tags: ['Health'],
|
|
407
|
+
summary: 'Health check',
|
|
408
|
+
description: 'Returns the health status of the API including active session count and uptime.',
|
|
409
|
+
operationId: 'healthCheck',
|
|
410
|
+
responses: {
|
|
411
|
+
'200': {
|
|
412
|
+
description: 'Health status',
|
|
413
|
+
content: {
|
|
414
|
+
'application/json': {
|
|
415
|
+
schema: { $ref: '#/components/schemas/HealthResponse' },
|
|
416
|
+
},
|
|
417
|
+
},
|
|
418
|
+
},
|
|
419
|
+
'429': { $ref: '#/components/responses/RateLimitError' },
|
|
420
|
+
},
|
|
421
|
+
},
|
|
422
|
+
},
|
|
423
|
+
},
|
|
424
|
+
components: {
|
|
425
|
+
parameters: {
|
|
426
|
+
SessionId: {
|
|
427
|
+
name: 'sessionId',
|
|
428
|
+
in: 'query',
|
|
429
|
+
required: true,
|
|
430
|
+
description: 'The session ID',
|
|
431
|
+
schema: { type: 'string' },
|
|
432
|
+
},
|
|
433
|
+
},
|
|
434
|
+
schemas: {
|
|
435
|
+
// Transport schemas
|
|
436
|
+
StdioTransportConfig: {
|
|
437
|
+
type: 'object',
|
|
438
|
+
required: ['type', 'command'],
|
|
439
|
+
properties: {
|
|
440
|
+
type: { type: 'string', enum: ['stdio'] },
|
|
441
|
+
command: { type: 'string', description: 'Command to execute' },
|
|
442
|
+
args: { type: 'array', items: { type: 'string' }, description: 'Command arguments' },
|
|
443
|
+
env: { type: 'object', additionalProperties: { type: 'string' }, description: 'Environment variables' },
|
|
444
|
+
cwd: { type: 'string', description: 'Working directory' },
|
|
445
|
+
},
|
|
446
|
+
},
|
|
447
|
+
SseTransportConfig: {
|
|
448
|
+
type: 'object',
|
|
449
|
+
required: ['type', 'url'],
|
|
450
|
+
properties: {
|
|
451
|
+
type: { type: 'string', enum: ['sse'] },
|
|
452
|
+
url: { type: 'string', format: 'uri', description: 'SSE endpoint URL' },
|
|
453
|
+
headers: { type: 'object', additionalProperties: { type: 'string' }, description: 'HTTP headers' },
|
|
454
|
+
},
|
|
455
|
+
},
|
|
456
|
+
HttpTransportConfig: {
|
|
457
|
+
type: 'object',
|
|
458
|
+
required: ['type', 'url'],
|
|
459
|
+
properties: {
|
|
460
|
+
type: { type: 'string', enum: ['http'] },
|
|
461
|
+
url: { type: 'string', format: 'uri', description: 'HTTP endpoint URL' },
|
|
462
|
+
headers: { type: 'object', additionalProperties: { type: 'string' }, description: 'HTTP headers' },
|
|
463
|
+
},
|
|
464
|
+
},
|
|
465
|
+
TransportConfig: {
|
|
466
|
+
oneOf: [
|
|
467
|
+
{ $ref: '#/components/schemas/StdioTransportConfig' },
|
|
468
|
+
{ $ref: '#/components/schemas/SseTransportConfig' },
|
|
469
|
+
{ $ref: '#/components/schemas/HttpTransportConfig' },
|
|
470
|
+
],
|
|
471
|
+
discriminator: {
|
|
472
|
+
propertyName: 'type',
|
|
473
|
+
mapping: {
|
|
474
|
+
stdio: '#/components/schemas/StdioTransportConfig',
|
|
475
|
+
sse: '#/components/schemas/SseTransportConfig',
|
|
476
|
+
http: '#/components/schemas/HttpTransportConfig',
|
|
477
|
+
},
|
|
478
|
+
},
|
|
479
|
+
},
|
|
480
|
+
|
|
481
|
+
// MCP entity schemas
|
|
482
|
+
McpCapabilities: {
|
|
483
|
+
type: 'object',
|
|
484
|
+
properties: {
|
|
485
|
+
tools: {
|
|
486
|
+
type: 'object',
|
|
487
|
+
properties: { listChanged: { type: 'boolean' } },
|
|
488
|
+
},
|
|
489
|
+
resources: {
|
|
490
|
+
type: 'object',
|
|
491
|
+
properties: {
|
|
492
|
+
subscribe: { type: 'boolean' },
|
|
493
|
+
listChanged: { type: 'boolean' },
|
|
494
|
+
},
|
|
495
|
+
},
|
|
496
|
+
prompts: {
|
|
497
|
+
type: 'object',
|
|
498
|
+
properties: { listChanged: { type: 'boolean' } },
|
|
499
|
+
},
|
|
500
|
+
},
|
|
501
|
+
},
|
|
502
|
+
McpServerInfo: {
|
|
503
|
+
type: 'object',
|
|
504
|
+
required: ['name', 'version'],
|
|
505
|
+
properties: {
|
|
506
|
+
name: { type: 'string' },
|
|
507
|
+
version: { type: 'string' },
|
|
508
|
+
protocolVersion: { type: 'string' },
|
|
509
|
+
},
|
|
510
|
+
},
|
|
511
|
+
McpTool: {
|
|
512
|
+
type: 'object',
|
|
513
|
+
required: ['name', 'inputSchema'],
|
|
514
|
+
properties: {
|
|
515
|
+
name: { type: 'string' },
|
|
516
|
+
description: { type: 'string' },
|
|
517
|
+
inputSchema: {
|
|
518
|
+
type: 'object',
|
|
519
|
+
properties: {
|
|
520
|
+
type: { type: 'string', enum: ['object'] },
|
|
521
|
+
properties: { type: 'object' },
|
|
522
|
+
required: { type: 'array', items: { type: 'string' } },
|
|
523
|
+
},
|
|
524
|
+
},
|
|
525
|
+
},
|
|
526
|
+
},
|
|
527
|
+
McpResource: {
|
|
528
|
+
type: 'object',
|
|
529
|
+
required: ['uri', 'name'],
|
|
530
|
+
properties: {
|
|
531
|
+
uri: { type: 'string' },
|
|
532
|
+
name: { type: 'string' },
|
|
533
|
+
description: { type: 'string' },
|
|
534
|
+
mimeType: { type: 'string' },
|
|
535
|
+
},
|
|
536
|
+
},
|
|
537
|
+
McpResourceTemplate: {
|
|
538
|
+
type: 'object',
|
|
539
|
+
required: ['uriTemplate', 'name'],
|
|
540
|
+
properties: {
|
|
541
|
+
uriTemplate: { type: 'string' },
|
|
542
|
+
name: { type: 'string' },
|
|
543
|
+
description: { type: 'string' },
|
|
544
|
+
mimeType: { type: 'string' },
|
|
545
|
+
},
|
|
546
|
+
},
|
|
547
|
+
McpResourceContents: {
|
|
548
|
+
type: 'object',
|
|
549
|
+
required: ['uri'],
|
|
550
|
+
properties: {
|
|
551
|
+
uri: { type: 'string' },
|
|
552
|
+
mimeType: { type: 'string' },
|
|
553
|
+
text: { type: 'string' },
|
|
554
|
+
blob: { type: 'string', description: 'Base64 encoded binary content' },
|
|
555
|
+
},
|
|
556
|
+
},
|
|
557
|
+
McpPrompt: {
|
|
558
|
+
type: 'object',
|
|
559
|
+
required: ['name'],
|
|
560
|
+
properties: {
|
|
561
|
+
name: { type: 'string' },
|
|
562
|
+
description: { type: 'string' },
|
|
563
|
+
arguments: {
|
|
564
|
+
type: 'array',
|
|
565
|
+
items: {
|
|
566
|
+
type: 'object',
|
|
567
|
+
required: ['name'],
|
|
568
|
+
properties: {
|
|
569
|
+
name: { type: 'string' },
|
|
570
|
+
description: { type: 'string' },
|
|
571
|
+
required: { type: 'boolean' },
|
|
572
|
+
},
|
|
573
|
+
},
|
|
574
|
+
},
|
|
575
|
+
},
|
|
576
|
+
},
|
|
577
|
+
McpPromptMessage: {
|
|
578
|
+
type: 'object',
|
|
579
|
+
required: ['role', 'content'],
|
|
580
|
+
properties: {
|
|
581
|
+
role: { type: 'string', enum: ['user', 'assistant'] },
|
|
582
|
+
content: {
|
|
583
|
+
type: 'object',
|
|
584
|
+
required: ['type'],
|
|
585
|
+
properties: {
|
|
586
|
+
type: { type: 'string', enum: ['text', 'image', 'resource'] },
|
|
587
|
+
text: { type: 'string' },
|
|
588
|
+
data: { type: 'string' },
|
|
589
|
+
mimeType: { type: 'string' },
|
|
590
|
+
},
|
|
591
|
+
},
|
|
592
|
+
},
|
|
593
|
+
},
|
|
594
|
+
McpToolResult: {
|
|
595
|
+
type: 'object',
|
|
596
|
+
required: ['content'],
|
|
597
|
+
properties: {
|
|
598
|
+
content: {
|
|
599
|
+
type: 'array',
|
|
600
|
+
items: {
|
|
601
|
+
type: 'object',
|
|
602
|
+
required: ['type'],
|
|
603
|
+
properties: {
|
|
604
|
+
type: { type: 'string', enum: ['text', 'image', 'resource'] },
|
|
605
|
+
text: { type: 'string' },
|
|
606
|
+
data: { type: 'string' },
|
|
607
|
+
mimeType: { type: 'string' },
|
|
608
|
+
},
|
|
609
|
+
},
|
|
610
|
+
},
|
|
611
|
+
isError: { type: 'boolean' },
|
|
612
|
+
},
|
|
613
|
+
},
|
|
614
|
+
SessionInfo: {
|
|
615
|
+
type: 'object',
|
|
616
|
+
required: ['id', 'transport', 'capabilities', 'serverInfo', 'createdAt', 'lastActivityAt', 'status'],
|
|
617
|
+
properties: {
|
|
618
|
+
id: { type: 'string' },
|
|
619
|
+
transport: { $ref: '#/components/schemas/TransportConfig' },
|
|
620
|
+
capabilities: { $ref: '#/components/schemas/McpCapabilities' },
|
|
621
|
+
serverInfo: { $ref: '#/components/schemas/McpServerInfo' },
|
|
622
|
+
createdAt: { type: 'string', format: 'date-time' },
|
|
623
|
+
lastActivityAt: { type: 'string', format: 'date-time' },
|
|
624
|
+
status: { type: 'string', enum: ['active', 'disconnected', 'error'] },
|
|
625
|
+
toolCount: { type: 'integer' },
|
|
626
|
+
resourceCount: { type: 'integer' },
|
|
627
|
+
promptCount: { type: 'integer' },
|
|
628
|
+
},
|
|
629
|
+
},
|
|
630
|
+
|
|
631
|
+
// Request schemas
|
|
632
|
+
ConnectRequest: {
|
|
633
|
+
type: 'object',
|
|
634
|
+
required: ['transport'],
|
|
635
|
+
properties: {
|
|
636
|
+
transport: { $ref: '#/components/schemas/TransportConfig' },
|
|
637
|
+
generatedCode: { type: 'string', description: 'Generated code to run as stdio server' },
|
|
638
|
+
},
|
|
639
|
+
},
|
|
640
|
+
DisconnectRequest: {
|
|
641
|
+
type: 'object',
|
|
642
|
+
required: ['sessionId'],
|
|
643
|
+
properties: {
|
|
644
|
+
sessionId: { type: 'string' },
|
|
645
|
+
},
|
|
646
|
+
},
|
|
647
|
+
ToolCallRequest: {
|
|
648
|
+
type: 'object',
|
|
649
|
+
required: ['sessionId', 'toolName'],
|
|
650
|
+
properties: {
|
|
651
|
+
sessionId: { type: 'string' },
|
|
652
|
+
toolName: { type: 'string' },
|
|
653
|
+
params: { type: 'object', additionalProperties: true },
|
|
654
|
+
},
|
|
655
|
+
},
|
|
656
|
+
ResourceReadRequest: {
|
|
657
|
+
type: 'object',
|
|
658
|
+
required: ['sessionId', 'uri'],
|
|
659
|
+
properties: {
|
|
660
|
+
sessionId: { type: 'string' },
|
|
661
|
+
uri: { type: 'string' },
|
|
662
|
+
},
|
|
663
|
+
},
|
|
664
|
+
PromptGetRequest: {
|
|
665
|
+
type: 'object',
|
|
666
|
+
required: ['sessionId', 'name'],
|
|
667
|
+
properties: {
|
|
668
|
+
sessionId: { type: 'string' },
|
|
669
|
+
name: { type: 'string' },
|
|
670
|
+
args: { type: 'object', additionalProperties: { type: 'string' } },
|
|
671
|
+
},
|
|
672
|
+
},
|
|
673
|
+
SessionsDeleteRequest: {
|
|
674
|
+
type: 'object',
|
|
675
|
+
properties: {
|
|
676
|
+
sessionId: { type: 'string', description: 'If omitted, deletes all sessions' },
|
|
677
|
+
},
|
|
678
|
+
},
|
|
679
|
+
|
|
680
|
+
// Response schemas
|
|
681
|
+
ApiError: {
|
|
682
|
+
type: 'object',
|
|
683
|
+
required: ['code', 'message', 'statusCode'],
|
|
684
|
+
properties: {
|
|
685
|
+
code: { type: 'string' },
|
|
686
|
+
message: { type: 'string' },
|
|
687
|
+
statusCode: { type: 'integer' },
|
|
688
|
+
},
|
|
689
|
+
},
|
|
690
|
+
ConnectResponse: {
|
|
691
|
+
type: 'object',
|
|
692
|
+
required: ['success'],
|
|
693
|
+
properties: {
|
|
694
|
+
success: { type: 'boolean' },
|
|
695
|
+
data: {
|
|
696
|
+
type: 'object',
|
|
697
|
+
properties: {
|
|
698
|
+
sessionId: { type: 'string' },
|
|
699
|
+
capabilities: { $ref: '#/components/schemas/McpCapabilities' },
|
|
700
|
+
serverInfo: { $ref: '#/components/schemas/McpServerInfo' },
|
|
701
|
+
tools: { type: 'array', items: { $ref: '#/components/schemas/McpTool' } },
|
|
702
|
+
},
|
|
703
|
+
},
|
|
704
|
+
error: { $ref: '#/components/schemas/ApiError' },
|
|
705
|
+
},
|
|
706
|
+
},
|
|
707
|
+
DisconnectResponse: {
|
|
708
|
+
type: 'object',
|
|
709
|
+
required: ['success'],
|
|
710
|
+
properties: {
|
|
711
|
+
success: { type: 'boolean' },
|
|
712
|
+
data: {
|
|
713
|
+
type: 'object',
|
|
714
|
+
properties: {
|
|
715
|
+
disconnected: { type: 'boolean' },
|
|
716
|
+
},
|
|
717
|
+
},
|
|
718
|
+
error: { $ref: '#/components/schemas/ApiError' },
|
|
719
|
+
},
|
|
720
|
+
},
|
|
721
|
+
ToolsListResponse: {
|
|
722
|
+
type: 'object',
|
|
723
|
+
required: ['success'],
|
|
724
|
+
properties: {
|
|
725
|
+
success: { type: 'boolean' },
|
|
726
|
+
data: {
|
|
727
|
+
type: 'object',
|
|
728
|
+
properties: {
|
|
729
|
+
tools: { type: 'array', items: { $ref: '#/components/schemas/McpTool' } },
|
|
730
|
+
},
|
|
731
|
+
},
|
|
732
|
+
error: { $ref: '#/components/schemas/ApiError' },
|
|
733
|
+
},
|
|
734
|
+
},
|
|
735
|
+
ToolCallResponse: {
|
|
736
|
+
type: 'object',
|
|
737
|
+
required: ['success'],
|
|
738
|
+
properties: {
|
|
739
|
+
success: { type: 'boolean' },
|
|
740
|
+
data: {
|
|
741
|
+
type: 'object',
|
|
742
|
+
properties: {
|
|
743
|
+
result: { $ref: '#/components/schemas/McpToolResult' },
|
|
744
|
+
executionTime: { type: 'integer', description: 'Execution time in milliseconds' },
|
|
745
|
+
logs: { type: 'array', items: { type: 'string' } },
|
|
746
|
+
},
|
|
747
|
+
},
|
|
748
|
+
error: { $ref: '#/components/schemas/ApiError' },
|
|
749
|
+
},
|
|
750
|
+
},
|
|
751
|
+
ResourcesListResponse: {
|
|
752
|
+
type: 'object',
|
|
753
|
+
required: ['success'],
|
|
754
|
+
properties: {
|
|
755
|
+
success: { type: 'boolean' },
|
|
756
|
+
data: {
|
|
757
|
+
type: 'object',
|
|
758
|
+
properties: {
|
|
759
|
+
resources: { type: 'array', items: { $ref: '#/components/schemas/McpResource' } },
|
|
760
|
+
resourceTemplates: { type: 'array', items: { $ref: '#/components/schemas/McpResourceTemplate' } },
|
|
761
|
+
},
|
|
762
|
+
},
|
|
763
|
+
error: { $ref: '#/components/schemas/ApiError' },
|
|
764
|
+
},
|
|
765
|
+
},
|
|
766
|
+
ResourceReadResponse: {
|
|
767
|
+
type: 'object',
|
|
768
|
+
required: ['success'],
|
|
769
|
+
properties: {
|
|
770
|
+
success: { type: 'boolean' },
|
|
771
|
+
data: {
|
|
772
|
+
type: 'object',
|
|
773
|
+
properties: {
|
|
774
|
+
contents: { type: 'array', items: { $ref: '#/components/schemas/McpResourceContents' } },
|
|
775
|
+
},
|
|
776
|
+
},
|
|
777
|
+
error: { $ref: '#/components/schemas/ApiError' },
|
|
778
|
+
},
|
|
779
|
+
},
|
|
780
|
+
PromptsListResponse: {
|
|
781
|
+
type: 'object',
|
|
782
|
+
required: ['success'],
|
|
783
|
+
properties: {
|
|
784
|
+
success: { type: 'boolean' },
|
|
785
|
+
data: {
|
|
786
|
+
type: 'object',
|
|
787
|
+
properties: {
|
|
788
|
+
prompts: { type: 'array', items: { $ref: '#/components/schemas/McpPrompt' } },
|
|
789
|
+
},
|
|
790
|
+
},
|
|
791
|
+
error: { $ref: '#/components/schemas/ApiError' },
|
|
792
|
+
},
|
|
793
|
+
},
|
|
794
|
+
PromptGetResponse: {
|
|
795
|
+
type: 'object',
|
|
796
|
+
required: ['success'],
|
|
797
|
+
properties: {
|
|
798
|
+
success: { type: 'boolean' },
|
|
799
|
+
data: {
|
|
800
|
+
type: 'object',
|
|
801
|
+
properties: {
|
|
802
|
+
description: { type: 'string' },
|
|
803
|
+
messages: { type: 'array', items: { $ref: '#/components/schemas/McpPromptMessage' } },
|
|
804
|
+
},
|
|
805
|
+
},
|
|
806
|
+
error: { $ref: '#/components/schemas/ApiError' },
|
|
807
|
+
},
|
|
808
|
+
},
|
|
809
|
+
SessionsListResponse: {
|
|
810
|
+
type: 'object',
|
|
811
|
+
required: ['success'],
|
|
812
|
+
properties: {
|
|
813
|
+
success: { type: 'boolean' },
|
|
814
|
+
data: {
|
|
815
|
+
type: 'object',
|
|
816
|
+
properties: {
|
|
817
|
+
sessions: { type: 'array', items: { $ref: '#/components/schemas/SessionInfo' } },
|
|
818
|
+
},
|
|
819
|
+
},
|
|
820
|
+
error: { $ref: '#/components/schemas/ApiError' },
|
|
821
|
+
},
|
|
822
|
+
},
|
|
823
|
+
SessionsDeleteResponse: {
|
|
824
|
+
type: 'object',
|
|
825
|
+
required: ['success'],
|
|
826
|
+
properties: {
|
|
827
|
+
success: { type: 'boolean' },
|
|
828
|
+
data: {
|
|
829
|
+
type: 'object',
|
|
830
|
+
properties: {
|
|
831
|
+
deleted: { type: 'integer' },
|
|
832
|
+
},
|
|
833
|
+
},
|
|
834
|
+
error: { $ref: '#/components/schemas/ApiError' },
|
|
835
|
+
},
|
|
836
|
+
},
|
|
837
|
+
HealthResponse: {
|
|
838
|
+
type: 'object',
|
|
839
|
+
required: ['success'],
|
|
840
|
+
properties: {
|
|
841
|
+
success: { type: 'boolean' },
|
|
842
|
+
data: {
|
|
843
|
+
type: 'object',
|
|
844
|
+
properties: {
|
|
845
|
+
activeSessions: { type: 'integer' },
|
|
846
|
+
uptime: { type: 'integer', description: 'Uptime in seconds' },
|
|
847
|
+
version: { type: 'string' },
|
|
848
|
+
timestamp: { type: 'string', format: 'date-time' },
|
|
849
|
+
},
|
|
850
|
+
},
|
|
851
|
+
error: { $ref: '#/components/schemas/ApiError' },
|
|
852
|
+
},
|
|
853
|
+
},
|
|
854
|
+
},
|
|
855
|
+
responses: {
|
|
856
|
+
ValidationError: {
|
|
857
|
+
description: 'Validation error',
|
|
858
|
+
content: {
|
|
859
|
+
'application/json': {
|
|
860
|
+
schema: {
|
|
861
|
+
type: 'object',
|
|
862
|
+
properties: {
|
|
863
|
+
success: { type: 'boolean', enum: [false] },
|
|
864
|
+
error: { $ref: '#/components/schemas/ApiError' },
|
|
865
|
+
},
|
|
866
|
+
},
|
|
867
|
+
},
|
|
868
|
+
},
|
|
869
|
+
},
|
|
870
|
+
NotFoundError: {
|
|
871
|
+
description: 'Resource not found',
|
|
872
|
+
content: {
|
|
873
|
+
'application/json': {
|
|
874
|
+
schema: {
|
|
875
|
+
type: 'object',
|
|
876
|
+
properties: {
|
|
877
|
+
success: { type: 'boolean', enum: [false] },
|
|
878
|
+
error: { $ref: '#/components/schemas/ApiError' },
|
|
879
|
+
},
|
|
880
|
+
},
|
|
881
|
+
},
|
|
882
|
+
},
|
|
883
|
+
},
|
|
884
|
+
SessionExpiredError: {
|
|
885
|
+
description: 'Session expired or not found',
|
|
886
|
+
content: {
|
|
887
|
+
'application/json': {
|
|
888
|
+
schema: {
|
|
889
|
+
type: 'object',
|
|
890
|
+
properties: {
|
|
891
|
+
success: { type: 'boolean', enum: [false] },
|
|
892
|
+
error: { $ref: '#/components/schemas/ApiError' },
|
|
893
|
+
},
|
|
894
|
+
},
|
|
895
|
+
},
|
|
896
|
+
},
|
|
897
|
+
},
|
|
898
|
+
ConnectionError: {
|
|
899
|
+
description: 'Failed to connect to MCP server',
|
|
900
|
+
content: {
|
|
901
|
+
'application/json': {
|
|
902
|
+
schema: {
|
|
903
|
+
type: 'object',
|
|
904
|
+
properties: {
|
|
905
|
+
success: { type: 'boolean', enum: [false] },
|
|
906
|
+
error: { $ref: '#/components/schemas/ApiError' },
|
|
907
|
+
},
|
|
908
|
+
},
|
|
909
|
+
},
|
|
910
|
+
},
|
|
911
|
+
},
|
|
912
|
+
ExecutionError: {
|
|
913
|
+
description: 'Execution failed',
|
|
914
|
+
content: {
|
|
915
|
+
'application/json': {
|
|
916
|
+
schema: {
|
|
917
|
+
type: 'object',
|
|
918
|
+
properties: {
|
|
919
|
+
success: { type: 'boolean', enum: [false] },
|
|
920
|
+
error: { $ref: '#/components/schemas/ApiError' },
|
|
921
|
+
},
|
|
922
|
+
},
|
|
923
|
+
},
|
|
924
|
+
},
|
|
925
|
+
},
|
|
926
|
+
RateLimitError: {
|
|
927
|
+
description: 'Rate limit exceeded',
|
|
928
|
+
headers: {
|
|
929
|
+
'X-RateLimit-Limit': {
|
|
930
|
+
schema: { type: 'string' },
|
|
931
|
+
description: 'Maximum requests per window',
|
|
932
|
+
},
|
|
933
|
+
'X-RateLimit-Remaining': {
|
|
934
|
+
schema: { type: 'string' },
|
|
935
|
+
description: 'Remaining requests',
|
|
936
|
+
},
|
|
937
|
+
'X-RateLimit-Reset': {
|
|
938
|
+
schema: { type: 'string' },
|
|
939
|
+
description: 'Seconds until reset',
|
|
940
|
+
},
|
|
941
|
+
'Retry-After': {
|
|
942
|
+
schema: { type: 'string' },
|
|
943
|
+
description: 'Seconds to wait before retrying',
|
|
944
|
+
},
|
|
945
|
+
},
|
|
946
|
+
content: {
|
|
947
|
+
'application/json': {
|
|
948
|
+
schema: {
|
|
949
|
+
type: 'object',
|
|
950
|
+
properties: {
|
|
951
|
+
success: { type: 'boolean', enum: [false] },
|
|
952
|
+
error: { $ref: '#/components/schemas/ApiError' },
|
|
953
|
+
},
|
|
954
|
+
},
|
|
955
|
+
},
|
|
956
|
+
},
|
|
957
|
+
},
|
|
958
|
+
},
|
|
959
|
+
},
|
|
960
|
+
};
|
|
961
|
+
|
|
962
|
+
/**
|
|
963
|
+
* Get the OpenAPI spec as JSON string
|
|
964
|
+
*/
|
|
965
|
+
export function getOpenApiJson(): string {
|
|
966
|
+
return JSON.stringify(openApiSpec, null, 2);
|
|
967
|
+
}
|
|
968
|
+
|
|
969
|
+
/**
|
|
970
|
+
* Get the OpenAPI spec as YAML string (requires js-yaml)
|
|
971
|
+
*/
|
|
972
|
+
export function getOpenApiYaml(): string {
|
|
973
|
+
// Simple YAML-like output without external dependency
|
|
974
|
+
return JSON.stringify(openApiSpec, null, 2)
|
|
975
|
+
.replace(/"/g, '')
|
|
976
|
+
.replace(/,$/gm, '');
|
|
977
|
+
}
|