zuplo 7.12.6 → 7.12.7
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/docs/ai-gateway/apps.mdx +3 -0
- package/docs/ai-gateway/azure-ai.mdx +3 -0
- package/docs/ai-gateway/bedrock-mantle.mdx +3 -0
- package/docs/ai-gateway/bedrock-runtime.mdx +3 -0
- package/docs/ai-gateway/budget-alerts.mdx +3 -0
- package/docs/ai-gateway/cookbooks/custom-fallback.mdx +3 -0
- package/docs/ai-gateway/cookbooks/dynamic-model-routing.mdx +3 -0
- package/docs/ai-gateway/cookbooks/sdk-path-shim.mdx +3 -0
- package/docs/ai-gateway/custom-policies.mdx +3 -0
- package/docs/ai-gateway/custom-pricing.mdx +3 -0
- package/docs/ai-gateway/custom-providers.mdx +3 -0
- package/docs/ai-gateway/fallback.mdx +3 -0
- package/docs/ai-gateway/integrations/ai-sdk.mdx +3 -0
- package/docs/ai-gateway/integrations/claude-code.mdx +3 -0
- package/docs/ai-gateway/integrations/claude-desktop.mdx +3 -0
- package/docs/ai-gateway/integrations/codex.mdx +3 -0
- package/docs/ai-gateway/integrations/github-copilot.mdx +3 -0
- package/docs/ai-gateway/integrations/goose.mdx +3 -0
- package/docs/ai-gateway/integrations/langchain.mdx +3 -0
- package/docs/ai-gateway/integrations/openai.mdx +3 -0
- package/docs/ai-gateway/jev.mdx +3 -0
- package/docs/ai-gateway/managing-apps.mdx +3 -0
- package/docs/ai-gateway/managing-pools.mdx +3 -0
- package/docs/ai-gateway/managing-providers.mdx +3 -0
- package/docs/ai-gateway/openrouter.mdx +3 -0
- package/docs/ai-gateway/overview.mdx +3 -0
- package/docs/ai-gateway/policies/overview.mdx +3 -0
- package/docs/ai-gateway/policy-chains.mdx +3 -0
- package/docs/ai-gateway/policy-templates.mdx +3 -0
- package/docs/ai-gateway/pools.mdx +3 -0
- package/docs/ai-gateway/providers.mdx +3 -0
- package/docs/ai-gateway/source-control.mdx +3 -0
- package/docs/ai-gateway/universal-api.mdx +3 -0
- package/docs/ai-gateway/usage-limits.mdx +3 -0
- package/docs/ai-gateway/user-apps.mdx +3 -0
- package/docs/ai-gateway/vertex-ai.mdx +3 -0
- package/docs/analytics/access-and-entitlements.md +3 -0
- package/docs/analytics/overview.md +9 -0
- package/docs/analytics/reference/metrics-glossary.md +3 -0
- package/docs/analytics/reference/url-parameters.md +3 -0
- package/docs/analytics/shared-controls.md +3 -0
- package/docs/analytics/tabs/agents.md +3 -0
- package/docs/analytics/tabs/consumers.md +3 -0
- package/docs/analytics/tabs/graphql.md +3 -0
- package/docs/analytics/tabs/mcp.md +3 -0
- package/docs/analytics/tabs/origins.md +3 -0
- package/docs/analytics/tabs/requests.md +12 -0
- package/docs/api-management/overview.md +12 -0
- package/docs/articles/accounts/audit-logs.mdx +3 -0
- package/docs/articles/accounts/billing.mdx +3 -0
- package/docs/articles/accounts/default-api-key.mdx +3 -0
- package/docs/articles/accounts/delete-account.mdx +3 -0
- package/docs/articles/accounts/enterprise-sso.mdx +3 -0
- package/docs/articles/accounts/managing-account-members.mdx +3 -0
- package/docs/articles/accounts/managing-project-members.mdx +3 -0
- package/docs/articles/accounts/members-and-roles.mdx +3 -0
- package/docs/articles/accounts/renew-sso-credentials.mdx +3 -0
- package/docs/articles/accounts/roles-and-permissions.mdx +3 -0
- package/docs/articles/accounts/switching-between-accounts.mdx +3 -0
- package/docs/articles/accounts/zuplo-api-keys.mdx +3 -0
- package/docs/articles/add-api-to-backstage.mdx +3 -0
- package/docs/articles/advanced-path-matching.mdx +3 -0
- package/docs/articles/api-key-administration.mdx +3 -0
- package/docs/articles/api-key-api.mdx +3 -0
- package/docs/articles/api-key-authentication.mdx +3 -0
- package/docs/articles/api-key-best-practices.mdx +10 -0
- package/docs/articles/api-key-buckets.mdx +3 -0
- package/docs/articles/api-key-consumer-bucket-portal-ui.mdx +3 -0
- package/docs/articles/api-key-end-users.mdx +3 -0
- package/docs/articles/api-key-leak-detection.mdx +3 -0
- package/docs/articles/api-key-management.mdx +10 -0
- package/docs/articles/api-key-metadata.mdx +3 -0
- package/docs/articles/api-key-react-component.mdx +3 -0
- package/docs/articles/api-key-self-serve-integration.mdx +3 -0
- package/docs/articles/api-key-service-limits.mdx +3 -0
- package/docs/articles/archiving-requests-to-storage.mdx +11 -0
- package/docs/articles/audit-logging.mdx +3 -0
- package/docs/articles/audit-logs.mdx +3 -0
- package/docs/articles/branch-based-deployments.mdx +13 -0
- package/docs/articles/bypass-policy-for-testing.mdx +3 -0
- package/docs/articles/certificate-pinning.mdx +12 -0
- package/docs/articles/check-ip-address.mdx +17 -9
- package/docs/articles/ci-cd-azure/basic-deployment.mdx +8 -0
- package/docs/articles/ci-cd-azure/deploy-and-test.mdx +8 -0
- package/docs/articles/ci-cd-azure/local-testing.mdx +8 -0
- package/docs/articles/ci-cd-azure/multi-stage-deployment.mdx +8 -0
- package/docs/articles/ci-cd-azure/pr-preview-environments.mdx +8 -0
- package/docs/articles/ci-cd-azure/tag-based-releases.mdx +8 -0
- package/docs/articles/ci-cd-bitbucket/basic-deployment.mdx +8 -0
- package/docs/articles/ci-cd-bitbucket/deploy-and-test.mdx +8 -0
- package/docs/articles/ci-cd-bitbucket/local-testing.mdx +8 -0
- package/docs/articles/ci-cd-bitbucket/multi-stage-deployment.mdx +8 -0
- package/docs/articles/ci-cd-bitbucket/pr-preview-environments.mdx +8 -0
- package/docs/articles/ci-cd-bitbucket/tag-based-releases.mdx +8 -0
- package/docs/articles/ci-cd-circleci/basic-deployment.mdx +8 -0
- package/docs/articles/ci-cd-circleci/deploy-and-test.mdx +8 -0
- package/docs/articles/ci-cd-circleci/local-testing.mdx +8 -0
- package/docs/articles/ci-cd-circleci/multi-stage-deployment.mdx +8 -0
- package/docs/articles/ci-cd-circleci/pr-preview-environments.mdx +8 -0
- package/docs/articles/ci-cd-circleci/tag-based-releases.mdx +8 -0
- package/docs/articles/ci-cd-github/basic-deployment.mdx +8 -0
- package/docs/articles/ci-cd-github/cleanup-on-branch-delete.mdx +8 -0
- package/docs/articles/ci-cd-github/deploy-and-test.mdx +8 -0
- package/docs/articles/ci-cd-github/local-testing.mdx +8 -0
- package/docs/articles/ci-cd-github/multi-stage-deployment.mdx +8 -0
- package/docs/articles/ci-cd-github/pr-preview-environments.mdx +8 -0
- package/docs/articles/ci-cd-github/tag-based-releases.mdx +8 -0
- package/docs/articles/ci-cd-gitlab/basic-deployment.mdx +8 -0
- package/docs/articles/ci-cd-gitlab/deploy-and-test.mdx +8 -0
- package/docs/articles/ci-cd-gitlab/local-testing.mdx +8 -0
- package/docs/articles/ci-cd-gitlab/mr-preview-environments.mdx +8 -0
- package/docs/articles/ci-cd-gitlab/multi-stage-deployment.mdx +8 -0
- package/docs/articles/ci-cd-gitlab/tag-based-releases.mdx +8 -0
- package/docs/articles/composite-policy-reference.mdx +3 -0
- package/docs/articles/configuring-auth0-for-mcp-auth.mdx +3 -0
- package/docs/articles/configuring-okta-for-mcp-auth.mdx +3 -0
- package/docs/articles/connect-to-aws-alb-with-mtls.mdx +10 -0
- package/docs/articles/convert-urls-to-openapi.mdx +3 -0
- package/docs/articles/cors.mdx +3 -0
- package/docs/articles/custom-audit-logs.mdx +3 -0
- package/docs/articles/custom-ci-cd-azure.mdx +8 -0
- package/docs/articles/custom-ci-cd-bitbucket.mdx +8 -0
- package/docs/articles/custom-ci-cd-circleci.mdx +8 -0
- package/docs/articles/custom-ci-cd-github.mdx +8 -0
- package/docs/articles/custom-ci-cd-gitlab.mdx +8 -0
- package/docs/articles/custom-ci-cd.mdx +8 -0
- package/docs/articles/custom-code-patterns.md +3 -0
- package/docs/articles/custom-domains.mdx +10 -0
- package/docs/articles/custom-logging-example.mdx +3 -0
- package/docs/articles/ddos-protection.mdx +3 -0
- package/docs/articles/development-options.mdx +7 -0
- package/docs/articles/environment-variables.mdx +8 -0
- package/docs/articles/environments.mdx +18 -8
- package/docs/articles/fastly-zuplo-host-setup.mdx +3 -0
- package/docs/articles/feature-flags.mdx +3 -0
- package/docs/articles/github-deployment-testing.mdx +3 -0
- package/docs/articles/gke-with-upstream-auth-policy.mdx +3 -0
- package/docs/articles/graphql-caching.mdx +3 -0
- package/docs/articles/graphql-security.mdx +3 -0
- package/docs/articles/graphql-support.mdx +3 -0
- package/docs/articles/graphql.mdx +3 -0
- package/docs/articles/handling-form-data.mdx +3 -0
- package/docs/articles/health-checks.mdx +3 -0
- package/docs/articles/hosting-options.mdx +3 -0
- package/docs/articles/lazy-load-configuration-into-cache.mdx +3 -0
- package/docs/articles/limits.mdx +7 -0
- package/docs/articles/local-development-debugging.mdx +3 -0
- package/docs/articles/local-development-env-variables.mdx +3 -0
- package/docs/articles/local-development-installing-packages.mdx +3 -0
- package/docs/articles/local-development-routes-designer.mdx +3 -0
- package/docs/articles/local-development-services.mdx +3 -0
- package/docs/articles/local-development-troubleshooting.mdx +7 -0
- package/docs/articles/local-development.mdx +3 -0
- package/docs/articles/log-plugin-aws-cloudwatch.mdx +14 -0
- package/docs/articles/log-plugin-datadog.mdx +3 -0
- package/docs/articles/log-plugin-dynatrace.mdx +14 -0
- package/docs/articles/log-plugin-gcp.mdx +14 -0
- package/docs/articles/log-plugin-loki.mdx +14 -0
- package/docs/articles/log-plugin-new-relic.mdx +3 -0
- package/docs/articles/log-plugin-splunk.mdx +3 -0
- package/docs/articles/log-plugin-sumo.mdx +14 -0
- package/docs/articles/log-plugin-vmware-log-insight.mdx +3 -0
- package/docs/articles/log-request-response-data.mdx +3 -0
- package/docs/articles/logging.mdx +14 -0
- package/docs/articles/manual-mcp-oauth-testing.mdx +3 -0
- package/docs/articles/metrics-plugins.mdx +10 -0
- package/docs/articles/migrate-from-apigee.md +10 -0
- package/docs/articles/migrate-from-aws-api-gateway.md +3 -0
- package/docs/articles/migrate-from-azure-apim.md +10 -0
- package/docs/articles/migrate-from-kong.md +10 -0
- package/docs/articles/migration-overview.md +10 -0
- package/docs/articles/monetization/api-access.mdx +3 -0
- package/docs/articles/monetization/billing-models.md +3 -0
- package/docs/articles/monetization/developer-portal.md +8 -0
- package/docs/articles/monetization/dynamic-metering.md +3 -0
- package/docs/articles/monetization/features.mdx +3 -0
- package/docs/articles/monetization/going-to-production.mdx +3 -0
- package/docs/articles/monetization/index.mdx +3 -0
- package/docs/articles/monetization/meters.mdx +3 -0
- package/docs/articles/monetization/monetization-policy.md +3 -0
- package/docs/articles/monetization/plan-examples.mdx +3 -0
- package/docs/articles/monetization/plans.mdx +3 -0
- package/docs/articles/monetization/pricing-models.mdx +3 -0
- package/docs/articles/monetization/private-plans.md +3 -0
- package/docs/articles/monetization/programmatic-monetization.md +3 -0
- package/docs/articles/monetization/quickstart.md +8 -0
- package/docs/articles/monetization/rate-cards.mdx +3 -0
- package/docs/articles/monetization/stripe-integration.md +3 -0
- package/docs/articles/monetization/subscription-data.md +3 -0
- package/docs/articles/monetization/subscription-lifecycle.md +3 -0
- package/docs/articles/monetization/tax-collection.md +3 -0
- package/docs/articles/monetization/troubleshooting.md +3 -0
- package/docs/articles/monetization-custom.mdx +3 -0
- package/docs/articles/monetization-integrations.mdx +3 -0
- package/docs/articles/monitoring-your-gateway.mdx +3 -0
- package/docs/articles/monorepo-deployment.mdx +3 -0
- package/docs/articles/multiple-auth-policies.mdx +3 -0
- package/docs/articles/non-standard-ports.mdx +3 -0
- package/docs/articles/oauth-authentication.mdx +3 -0
- package/docs/articles/openapi-server-urls.mdx +12 -0
- package/docs/articles/openapi-string-format-validation-warnings.mdx +3 -0
- package/docs/articles/openapi.mdx +3 -0
- package/docs/articles/opentelemetry.mdx +3 -0
- package/docs/articles/performance-testing.mdx +9 -0
- package/docs/articles/plugin-akamai-api-security.mdx +3 -0
- package/docs/articles/plugin-azure-blob.mdx +3 -0
- package/docs/articles/plugin-azure-event-hubs.mdx +3 -0
- package/docs/articles/plugin-hydrolix-traffic-peak.mdx +12 -0
- package/docs/articles/policies.mdx +3 -0
- package/docs/articles/rename-or-move-project.mdx +3 -0
- package/docs/articles/rick-and-morty-api-developer-portal-example.mdx +3 -0
- package/docs/articles/routing.mdx +3 -0
- package/docs/articles/s3-signed-url-uploads.mdx +8 -0
- package/docs/articles/secure-tunnel.mdx +16 -5
- package/docs/articles/securing-backend-mtls.mdx +9 -0
- package/docs/articles/securing-the-gateway-with-client-mtls.mdx +3 -0
- package/docs/articles/securing-your-backend.mdx +7 -0
- package/docs/articles/security.mdx +11 -0
- package/docs/articles/sharing-code-across-projects.mdx +3 -0
- package/docs/articles/source-control-setup-azure.mdx +3 -0
- package/docs/articles/source-control-setup-bitbucket.mdx +3 -0
- package/docs/articles/source-control-setup-github.mdx +3 -0
- package/docs/articles/source-control-setup-gitlab.mdx +3 -0
- package/docs/articles/source-control.mdx +12 -0
- package/docs/articles/streaming-responses-sse.mdx +3 -0
- package/docs/articles/support.mdx +3 -0
- package/docs/articles/terraform.mdx +3 -0
- package/docs/articles/testing-getting-started.mdx +3 -0
- package/docs/articles/testing-graphql.mdx +3 -0
- package/docs/articles/testing-preview-environments.mdx +3 -0
- package/docs/articles/testing-recipes.mdx +3 -0
- package/docs/articles/testing.mdx +3 -0
- package/docs/articles/troubleshooting-deployments-and-git-sync.mdx +3 -0
- package/docs/articles/troubleshooting-slow-responses.mdx +10 -0
- package/docs/articles/troubleshooting.md +14 -0
- package/docs/articles/tsconfig.mdx +3 -0
- package/docs/articles/tunnel-advanced.mdx +48 -104
- package/docs/articles/tunnel-services.mdx +14 -2
- package/docs/articles/tunnel-setup.mdx +12 -0
- package/docs/articles/tunnel-troubleshooting.mdx +12 -0
- package/docs/articles/update-zup-in-github-action.mdx +3 -0
- package/docs/articles/upstream-iam-auth.mdx +3 -0
- package/docs/articles/use-openapi-extension-data.mdx +3 -0
- package/docs/articles/users/multifactor-authentication.mdx +3 -0
- package/docs/articles/users/profile.mdx +3 -0
- package/docs/articles/version-support-policy.mdx +3 -0
- package/docs/articles/versioning-on-zuplo.mdx +3 -0
- package/docs/articles/waf-ddos-akamai.md +3 -0
- package/docs/articles/waf-ddos-aws-waf-shield.mdx +3 -0
- package/docs/articles/waf-ddos-fastly.mdx +3 -0
- package/docs/articles/waf-ddos.mdx +8 -0
- package/docs/articles/when-to-use-api-keys.md +3 -0
- package/docs/articles/workload-identity-inbound.mdx +3 -0
- package/docs/build-with-ai.mdx +3 -0
- package/docs/caching/cdn-caching.mdx +3 -0
- package/docs/caching/custom-caching-policy.mdx +3 -0
- package/docs/caching/dynamic-cache-rules.mdx +3 -0
- package/docs/caching/gateway-caching.mdx +3 -0
- package/docs/caching/overview.mdx +3 -0
- package/docs/caching/partial-response-caching.mdx +3 -0
- package/docs/cli/authentication.mdx +3 -0
- package/docs/cli/bucket-list.mdx +3 -0
- package/docs/cli/ca-certificate-create.mdx +3 -0
- package/docs/cli/ca-certificate-delete.mdx +3 -0
- package/docs/cli/ca-certificate-describe.mdx +3 -0
- package/docs/cli/ca-certificate-list.mdx +3 -0
- package/docs/cli/ca-certificate-update.mdx +3 -0
- package/docs/cli/connectivity.mdx +3 -0
- package/docs/cli/create-zuplo-api.mdx +3 -0
- package/docs/cli/custom-domain-create.mdx +6 -0
- package/docs/cli/custom-domain-delete.mdx +6 -0
- package/docs/cli/custom-domain-list.mdx +6 -0
- package/docs/cli/custom-domain-update.mdx +6 -0
- package/docs/cli/delete.mdx +5 -0
- package/docs/cli/deploy.mdx +5 -0
- package/docs/cli/dev.mdx +5 -0
- package/docs/cli/docs.mdx +3 -0
- package/docs/cli/editor.mdx +3 -0
- package/docs/cli/global-options.mdx +3 -0
- package/docs/cli/info.mdx +3 -0
- package/docs/cli/init.mdx +3 -0
- package/docs/cli/link.mdx +3 -0
- package/docs/cli/lint.mdx +3 -0
- package/docs/cli/list.mdx +5 -0
- package/docs/cli/logout.mdx +3 -0
- package/docs/cli/mtls-certificate-create.mdx +3 -0
- package/docs/cli/mtls-certificate-delete.mdx +3 -0
- package/docs/cli/mtls-certificate-describe.mdx +3 -0
- package/docs/cli/mtls-certificate-disable.mdx +3 -0
- package/docs/cli/mtls-certificate-list.mdx +3 -0
- package/docs/cli/mtls-certificate-update.mdx +3 -0
- package/docs/cli/openapi-convert.mdx +3 -0
- package/docs/cli/openapi-merge.mdx +3 -0
- package/docs/cli/openapi-overlay.mdx +3 -0
- package/docs/cli/overview.mdx +18 -15
- package/docs/cli/project-create.mdx +3 -0
- package/docs/cli/project-info.mdx +3 -0
- package/docs/cli/project-list.mdx +3 -0
- package/docs/cli/source-migrate.mdx +3 -0
- package/docs/cli/source-upgrade.mdx +3 -0
- package/docs/cli/test.mdx +3 -0
- package/docs/cli/tunnel-create.mdx +3 -0
- package/docs/cli/tunnel-delete.mdx +3 -0
- package/docs/cli/tunnel-describe.mdx +3 -0
- package/docs/cli/tunnel-list.mdx +3 -0
- package/docs/cli/tunnel-rotate-token.mdx +3 -0
- package/docs/cli/tunnel-services-describe.mdx +3 -0
- package/docs/cli/tunnel-services-update.mdx +3 -0
- package/docs/cli/variable-create.mdx +3 -0
- package/docs/cli/variable-update.mdx +3 -0
- package/docs/cli/whoami.mdx +3 -0
- package/docs/concepts/ai-gateway.mdx +3 -0
- package/docs/concepts/api-errors.md +3 -0
- package/docs/concepts/api-keys.md +12 -0
- package/docs/concepts/authentication.mdx +3 -0
- package/docs/concepts/how-zuplo-works.mdx +3 -0
- package/docs/concepts/mcp.mdx +3 -0
- package/docs/concepts/project-structure.mdx +3 -0
- package/docs/concepts/request-lifecycle.mdx +3 -0
- package/docs/concepts/source-control-and-deployment.mdx +14 -0
- package/docs/concepts/upstream-credentials.mdx +3 -0
- package/docs/concepts/where-zuplo-runs.mdx +124 -0
- package/docs/dedicated/akamai/ai-powered-applications.mdx +3 -0
- package/docs/dedicated/akamai/architecture.mdx +4 -1
- package/docs/dedicated/akamai/caching.mdx +3 -0
- package/docs/dedicated/akamai/cdn.mdx +3 -0
- package/docs/dedicated/architecture.mdx +3 -0
- package/docs/dedicated/aws/architecture.mdx +3 -0
- package/docs/dedicated/aws/private-networking.mdx +3 -0
- package/docs/dedicated/azure/architecture.mdx +3 -0
- package/docs/dedicated/azure/private-networking.mdx +3 -0
- package/docs/dedicated/configuration/host-header-override.mdx +3 -0
- package/docs/dedicated/configuration/overview.mdx +3 -0
- package/docs/dedicated/custom-domains.mdx +3 -0
- package/docs/dedicated/federated-gateways.mdx +4 -0
- package/docs/dedicated/gcp/architecture.mdx +3 -0
- package/docs/dedicated/gcp/private-networking.mdx +3 -0
- package/docs/dedicated/networking.mdx +3 -0
- package/docs/dedicated/overview.mdx +3 -0
- package/docs/dedicated/source-control.mdx +3 -0
- package/docs/dev-portal/auth-provider-api-identities.md +3 -0
- package/docs/dev-portal/branding.mdx +3 -0
- package/docs/dev-portal/dev-portal-create-consumer-on-auth.mdx +3 -0
- package/docs/dev-portal/documenting-mcp-servers.mdx +3 -0
- package/docs/dev-portal/migration.mdx +9 -0
- package/docs/dev-portal/node-modules.mdx +3 -0
- package/docs/dev-portal/overview.mdx +10 -0
- package/docs/dev-portal/server-side-rendering.mdx +4 -0
- package/docs/dev-portal/updating.mdx +3 -0
- package/docs/dev-portal/zudoku/components/alert.mdx +3 -0
- package/docs/dev-portal/zudoku/components/badge.mdx +3 -0
- package/docs/dev-portal/zudoku/components/browser-window.mdx +3 -0
- package/docs/dev-portal/zudoku/components/button.mdx +3 -0
- package/docs/dev-portal/zudoku/components/callout.mdx +3 -0
- package/docs/dev-portal/zudoku/components/card.mdx +3 -0
- package/docs/dev-portal/zudoku/components/checkbox.mdx +3 -0
- package/docs/dev-portal/zudoku/components/client-only.mdx +3 -0
- package/docs/dev-portal/zudoku/components/code-tabs.mdx +3 -0
- package/docs/dev-portal/zudoku/components/dialog.mdx +3 -0
- package/docs/dev-portal/zudoku/components/head.mdx +3 -0
- package/docs/dev-portal/zudoku/components/icons.mdx +3 -0
- package/docs/dev-portal/zudoku/components/input.mdx +3 -0
- package/docs/dev-portal/zudoku/components/label.mdx +3 -0
- package/docs/dev-portal/zudoku/components/landing-page.mdx +3 -0
- package/docs/dev-portal/zudoku/components/link.mdx +3 -0
- package/docs/dev-portal/zudoku/components/markdown.mdx +3 -0
- package/docs/dev-portal/zudoku/components/mermaid.mdx +3 -0
- package/docs/dev-portal/zudoku/components/playground.mdx +3 -0
- package/docs/dev-portal/zudoku/components/secret.mdx +3 -0
- package/docs/dev-portal/zudoku/components/select.mdx +3 -0
- package/docs/dev-portal/zudoku/components/shadcn.mdx +3 -0
- package/docs/dev-portal/zudoku/components/sidecar-box.mdx +3 -0
- package/docs/dev-portal/zudoku/components/slider.mdx +3 -0
- package/docs/dev-portal/zudoku/components/slot.mdx +3 -0
- package/docs/dev-portal/zudoku/components/stepper.mdx +3 -0
- package/docs/dev-portal/zudoku/components/switch.mdx +3 -0
- package/docs/dev-portal/zudoku/components/syntax-highlight.mdx +3 -0
- package/docs/dev-portal/zudoku/components/textarea.mdx +3 -0
- package/docs/dev-portal/zudoku/components/tooltip.mdx +3 -0
- package/docs/dev-portal/zudoku/components/typography.mdx +3 -0
- package/docs/dev-portal/zudoku/configuration/ai-assistants.md +3 -0
- package/docs/dev-portal/zudoku/configuration/api-catalog.md +3 -0
- package/docs/dev-portal/zudoku/configuration/api-reference.md +3 -0
- package/docs/dev-portal/zudoku/configuration/authentication-auth0.md +3 -0
- package/docs/dev-portal/zudoku/configuration/authentication-azure-ad.md +3 -0
- package/docs/dev-portal/zudoku/configuration/authentication-clerk.md +3 -0
- package/docs/dev-portal/zudoku/configuration/authentication-firebase.md +3 -0
- package/docs/dev-portal/zudoku/configuration/authentication-openid.md +3 -0
- package/docs/dev-portal/zudoku/configuration/authentication-pingfederate.md +3 -0
- package/docs/dev-portal/zudoku/configuration/authentication-supabase.md +3 -0
- package/docs/dev-portal/zudoku/configuration/authentication.md +3 -0
- package/docs/dev-portal/zudoku/configuration/build-configuration.mdx +3 -0
- package/docs/dev-portal/zudoku/configuration/docs.md +3 -0
- package/docs/dev-portal/zudoku/configuration/footer.mdx +3 -0
- package/docs/dev-portal/zudoku/configuration/llms.md +3 -0
- package/docs/dev-portal/zudoku/configuration/navigation.mdx +3 -0
- package/docs/dev-portal/zudoku/configuration/oauth-security-schemes.md +3 -0
- package/docs/dev-portal/zudoku/configuration/overview.md +3 -0
- package/docs/dev-portal/zudoku/configuration/protected-routes.md +3 -0
- package/docs/dev-portal/zudoku/configuration/search.md +3 -0
- package/docs/dev-portal/zudoku/configuration/sentry.mdx +3 -0
- package/docs/dev-portal/zudoku/configuration/site.md +3 -0
- package/docs/dev-portal/zudoku/configuration/slots.mdx +3 -0
- package/docs/dev-portal/zudoku/configuration/vite-config.md +3 -0
- package/docs/dev-portal/zudoku/custom-plugins.md +3 -0
- package/docs/dev-portal/zudoku/customization/colors-theme.mdx +3 -0
- package/docs/dev-portal/zudoku/customization/fonts.md +3 -0
- package/docs/dev-portal/zudoku/extending/events.md +3 -0
- package/docs/dev-portal/zudoku/extending/hooks.md +3 -0
- package/docs/dev-portal/zudoku/guides/custom-pages.md +3 -0
- package/docs/dev-portal/zudoku/guides/environment-variables.md +3 -0
- package/docs/dev-portal/zudoku/guides/mermaid.mdx +3 -0
- package/docs/dev-portal/zudoku/guides/navigation-migration.md +3 -0
- package/docs/dev-portal/zudoku/guides/navigation-rules.mdx +3 -0
- package/docs/dev-portal/zudoku/guides/processors.mdx +3 -0
- package/docs/dev-portal/zudoku/guides/redirects.md +3 -0
- package/docs/dev-portal/zudoku/guides/server-side-content-protection.md +3 -0
- package/docs/dev-portal/zudoku/guides/static-files.md +3 -0
- package/docs/dev-portal/zudoku/guides/transforming-examples.md +3 -0
- package/docs/dev-portal/zudoku/guides/using-multiple-apis.md +3 -0
- package/docs/dev-portal/zudoku/markdown/admonitions.md +3 -0
- package/docs/dev-portal/zudoku/markdown/code-blocks.md +3 -0
- package/docs/dev-portal/zudoku/markdown/frontmatter.md +3 -0
- package/docs/dev-portal/zudoku/markdown/mdx.md +3 -0
- package/docs/dev-portal/zudoku/markdown/overview.md +3 -0
- package/docs/dev-portal/zudoku/openapi-extensions/x-code-samples.md +3 -0
- package/docs/dev-portal/zudoku/openapi-extensions/x-display-name.md +3 -0
- package/docs/dev-portal/zudoku/openapi-extensions/x-internal.md +3 -0
- package/docs/dev-portal/zudoku/openapi-extensions/x-mcp-server.md +3 -0
- package/docs/dev-portal/zudoku/openapi-extensions/x-mcp.md +3 -0
- package/docs/dev-portal/zudoku/openapi-extensions/x-tag-groups.md +3 -0
- package/docs/dev-portal/zudoku/openapi-extensions/x-zudoku-collapsed.md +3 -0
- package/docs/dev-portal/zudoku/openapi-extensions/x-zudoku-collapsible.md +3 -0
- package/docs/dev-portal/zudoku/openapi-extensions/x-zudoku-playground-enabled.md +3 -0
- package/docs/dev-portal/zudoku/openapi-extensions/x-zudoku-request-box-enabled.md +3 -0
- package/docs/dev-portal/zudoku/openapi-extensions/x-zudoku-seo.md +3 -0
- package/docs/dev-portal/zudoku/openapi-extensions/x-zudoku-type.md +3 -0
- package/docs/dev-portal/zudoku/plugins.md +3 -0
- package/docs/dev-portal/zudoku/writing.mdx +3 -0
- package/docs/errors/bad-request.mdx +3 -0
- package/docs/errors/build-error.mdx +3 -0
- package/docs/errors/fatal-project-error.mdx +3 -0
- package/docs/errors/gateway-timeout.mdx +3 -0
- package/docs/errors/main-mod-error.mdx +3 -0
- package/docs/errors/no-project-set.mdx +3 -0
- package/docs/errors/not-found.mdx +3 -0
- package/docs/errors/rate-limit-exceeded.mdx +3 -0
- package/docs/errors/schema-validation-failed.mdx +3 -0
- package/docs/errors/system-configuration-error.mdx +3 -0
- package/docs/errors/unauthorized.mdx +3 -0
- package/docs/errors/unknown-error.mdx +3 -0
- package/docs/errors.mdx +6 -0
- package/docs/guides/canary-routing-for-employees.mdx +3 -0
- package/docs/guides/geolocation-backend-routing.mdx +12 -0
- package/docs/guides/modify-openapi-paths.mdx +3 -0
- package/docs/guides/openapi-overlays.mdx +3 -0
- package/docs/guides/overview.mdx +3 -0
- package/docs/guides/proxying-between-zuplo-gateways.mdx +10 -0
- package/docs/guides/transform-route-params-url-rewrite.mdx +3 -0
- package/docs/guides/user-based-backend-routing.mdx +3 -0
- package/docs/handlers/aws-lambda.mdx +3 -0
- package/docs/handlers/custom-handler.mdx +3 -0
- package/docs/handlers/legacy-dev-portal-handler.mdx +3 -0
- package/docs/handlers/mcp-server.mdx +3 -0
- package/docs/handlers/openapi.mdx +3 -0
- package/docs/handlers/redirect.mdx +3 -0
- package/docs/handlers/system-handlers.mdx +3 -0
- package/docs/handlers/url-forward.mdx +3 -0
- package/docs/handlers/url-rewrite.mdx +3 -0
- package/docs/handlers/websocket-handler.mdx +3 -0
- package/docs/handlers/websocket-pipeline-handler.mdx +3 -0
- package/docs/managed-edge/overview.md +3 -0
- package/docs/mcp-gateway/auth/configuring-auth0.mdx +3 -0
- package/docs/mcp-gateway/auth/configuring-clerk.mdx +3 -0
- package/docs/mcp-gateway/auth/configuring-cognito.mdx +3 -0
- package/docs/mcp-gateway/auth/configuring-entra.mdx +3 -0
- package/docs/mcp-gateway/auth/configuring-generic-oidc.mdx +3 -0
- package/docs/mcp-gateway/auth/configuring-google.mdx +3 -0
- package/docs/mcp-gateway/auth/configuring-keycloak.mdx +3 -0
- package/docs/mcp-gateway/auth/configuring-logto.mdx +3 -0
- package/docs/mcp-gateway/auth/configuring-okta.mdx +3 -0
- package/docs/mcp-gateway/auth/configuring-onelogin.mdx +3 -0
- package/docs/mcp-gateway/auth/configuring-ping.mdx +3 -0
- package/docs/mcp-gateway/auth/configuring-workos.mdx +3 -0
- package/docs/mcp-gateway/auth/manual-oauth-testing.mdx +3 -0
- package/docs/mcp-gateway/auth/overview.mdx +3 -0
- package/docs/mcp-gateway/auth/upstream-oauth.mdx +3 -0
- package/docs/mcp-gateway/capability-filtering.mdx +3 -0
- package/docs/mcp-gateway/code-config/compatibility-dates.mdx +3 -0
- package/docs/mcp-gateway/code-config/local-development.mdx +3 -0
- package/docs/mcp-gateway/code-config/mcp-proxy-handler.mdx +3 -0
- package/docs/mcp-gateway/code-config/multi-upstream.mdx +3 -0
- package/docs/mcp-gateway/code-config/overview.mdx +3 -0
- package/docs/mcp-gateway/connect-clients/chatgpt.mdx +3 -0
- package/docs/mcp-gateway/connect-clients/claude-code.mdx +3 -0
- package/docs/mcp-gateway/connect-clients/claude-desktop.mdx +3 -0
- package/docs/mcp-gateway/connect-clients/cursor.mdx +3 -0
- package/docs/mcp-gateway/connect-clients/other-clients.mdx +3 -0
- package/docs/mcp-gateway/connect-clients/overview.mdx +3 -0
- package/docs/mcp-gateway/connect-clients/vs-code.mdx +3 -0
- package/docs/mcp-gateway/cross-app-access/overview.mdx +3 -0
- package/docs/mcp-gateway/cross-app-access/policy-reference.mdx +3 -0
- package/docs/mcp-gateway/cross-app-access/quickstart.mdx +3 -0
- package/docs/mcp-gateway/how-it-works.mdx +3 -0
- package/docs/mcp-gateway/how-to/connect-upstream-api-key.mdx +3 -0
- package/docs/mcp-gateway/how-to/connect-upstream-oauth.mdx +3 -0
- package/docs/mcp-gateway/how-to/curate-tools-local.mdx +3 -0
- package/docs/mcp-gateway/how-to/curate-tools.mdx +3 -0
- package/docs/mcp-gateway/observability/analytics.mdx +3 -0
- package/docs/mcp-gateway/observability/logging.mdx +3 -0
- package/docs/mcp-gateway/overview.mdx +3 -0
- package/docs/mcp-gateway/policies/overview.mdx +3 -0
- package/docs/mcp-gateway/reference.mdx +3 -0
- package/docs/mcp-gateway/server-registry.mdx +3 -0
- package/docs/mcp-gateway/test-clients.mdx +3 -0
- package/docs/mcp-gateway/troubleshooting.mdx +3 -0
- package/docs/mcp-server/configuration-migration-guide.mdx +3 -0
- package/docs/mcp-server/custom-tools.mdx +3 -0
- package/docs/mcp-server/graphql.mdx +3 -0
- package/docs/mcp-server/openai-apps-sdk.mdx +3 -0
- package/docs/mcp-server/overview.mdx +3 -0
- package/docs/mcp-server/prompts.mdx +3 -0
- package/docs/mcp-server/resources.mdx +3 -0
- package/docs/mcp-server/testing.mdx +3 -0
- package/docs/mcp-server/tools.mdx +3 -0
- package/docs/mcp-server/troubleshooting.mdx +3 -0
- package/docs/policies/_index.md +1 -1
- package/docs/policies/ai-gateway-metering-inbound/doc.md +6 -7
- package/docs/policies/ai-gateway-metering-inbound/intro.md +2 -3
- package/docs/policies/ai-gateway-metering-inbound/schema.json +7 -6
- package/docs/programmable-api/background-dispatcher.mdx +3 -0
- package/docs/programmable-api/background-loader.mdx +3 -0
- package/docs/programmable-api/cache.mdx +3 -0
- package/docs/programmable-api/compatibility-dates.mdx +3 -0
- package/docs/programmable-api/console-logging.mdx +3 -0
- package/docs/programmable-api/context-data.mdx +3 -0
- package/docs/programmable-api/custom-cors-policy.mdx +3 -0
- package/docs/programmable-api/environment.mdx +10 -0
- package/docs/programmable-api/hooks.mdx +3 -0
- package/docs/programmable-api/http-problems.mdx +3 -0
- package/docs/programmable-api/jwt-service-plugin.mdx +3 -0
- package/docs/programmable-api/logger.mdx +3 -0
- package/docs/programmable-api/mcp-gateway-plugin.mdx +3 -0
- package/docs/programmable-api/mcp-sdk.mdx +3 -0
- package/docs/programmable-api/memory-zone-read-through-cache.mdx +3 -0
- package/docs/programmable-api/node-modules.mdx +3 -0
- package/docs/programmable-api/not-found-handler.mdx +3 -0
- package/docs/programmable-api/oauth-protected-resource-plugin.mdx +3 -0
- package/docs/programmable-api/overview.mdx +3 -0
- package/docs/programmable-api/problem-response-formatter.mdx +3 -0
- package/docs/programmable-api/request-user.mdx +3 -0
- package/docs/programmable-api/reusing-code.mdx +3 -0
- package/docs/programmable-api/route-raw.mdx +3 -0
- package/docs/programmable-api/runtime-behaviors.mdx +3 -0
- package/docs/programmable-api/runtime-errors.mdx +3 -0
- package/docs/programmable-api/runtime-extensions.mdx +10 -0
- package/docs/programmable-api/safely-clone-a-request-or-response.mdx +3 -0
- package/docs/programmable-api/streaming-zone-cache.mdx +3 -0
- package/docs/programmable-api/web-crypto-apis.mdx +3 -0
- package/docs/programmable-api/web-standard-apis.mdx +3 -0
- package/docs/programmable-api/zone-cache.mdx +3 -0
- package/docs/programmable-api/zp-body-removed.mdx +3 -0
- package/docs/programmable-api/zuplo-context.mdx +12 -0
- package/docs/programmable-api/zuplo-id-token.mdx +3 -0
- package/docs/programmable-api/zuplo-json.mdx +6 -0
- package/docs/programmable-api/zuplo-request.mdx +3 -0
- package/docs/rate-limiting/combining-policies.mdx +3 -0
- package/docs/rate-limiting/dynamic-rate-limiting.mdx +3 -0
- package/docs/rate-limiting/getting-started.mdx +3 -0
- package/docs/rate-limiting/how-it-works.md +3 -0
- package/docs/rate-limiting/monitoring-and-troubleshooting.mdx +3 -0
- package/docs/rate-limiting/per-user-rate-limits-using-db.mdx +3 -0
- package/docs/sample-apis.mdx +3 -0
- package/docs/self-hosted/install.md +3 -0
- package/docs/self-hosted/overview.md +3 -0
- package/docs/self-hosted/requirements.md +3 -0
- package/docs/self-hosted/troubleshooting.md +3 -0
- package/docs/self-hosted/upgrade.md +3 -0
- package/package.json +5 -5
|
@@ -5,6 +5,9 @@ description:
|
|
|
5
5
|
How authentication works in the Zuplo MCP Gateway — the gateway as an OAuth
|
|
6
6
|
2.1 server for MCP clients, and as an OAuth client to each upstream MCP
|
|
7
7
|
server.
|
|
8
|
+
applies_to:
|
|
9
|
+
product: gateway
|
|
10
|
+
hosting: all
|
|
8
11
|
---
|
|
9
12
|
|
|
10
13
|
The Zuplo MCP Gateway sits in the middle of two independent OAuth relationships.
|
|
@@ -5,6 +5,9 @@ description:
|
|
|
5
5
|
How the Zuplo MCP Gateway acts as an OAuth client to upstream MCP servers —
|
|
6
6
|
the two auth modes, client registration, the consent flow users experience,
|
|
7
7
|
connect-required states, and token refresh.
|
|
8
|
+
applies_to:
|
|
9
|
+
product: gateway
|
|
10
|
+
hosting: all
|
|
8
11
|
---
|
|
9
12
|
|
|
10
13
|
The gateway sits between an MCP client and the upstream MCP servers a team
|
|
@@ -6,6 +6,9 @@ description:
|
|
|
6
6
|
templates an upstream MCP server exposes — what the
|
|
7
7
|
mcp-capability-filter-inbound policy filters, how projections work, and where
|
|
8
8
|
the boundary actually lives.
|
|
9
|
+
applies_to:
|
|
10
|
+
product: gateway
|
|
11
|
+
hosting: all
|
|
9
12
|
---
|
|
10
13
|
|
|
11
14
|
The Model Context Protocol lets a server advertise tools, prompts, resources,
|
|
@@ -4,6 +4,9 @@ sidebar_label: "Compatibility dates"
|
|
|
4
4
|
description:
|
|
5
5
|
The Zuplo MCP Gateway requires compatibilityDate 2026-03-01 or later in
|
|
6
6
|
zuplo.jsonc.
|
|
7
|
+
applies_to:
|
|
8
|
+
product: gateway
|
|
9
|
+
hosting: all
|
|
7
10
|
---
|
|
8
11
|
|
|
9
12
|
The Zuplo MCP Gateway requires `compatibilityDate >= 2026-03-01` in
|
|
@@ -4,6 +4,9 @@ sidebar_label: "Local development"
|
|
|
4
4
|
description:
|
|
5
5
|
Run the MCP Gateway locally, test OAuth without an identity provider, and
|
|
6
6
|
configure local callback URLs and environment variables for your MCP clients.
|
|
7
|
+
applies_to:
|
|
8
|
+
product: gateway
|
|
9
|
+
hosting: all
|
|
7
10
|
---
|
|
8
11
|
|
|
9
12
|
Use `zuplo dev` to run the MCP Gateway locally on port `9000` with hot reload.
|
|
@@ -5,6 +5,9 @@ description:
|
|
|
5
5
|
The route handler that turns a Zuplo path into an MCP Gateway endpoint —
|
|
6
6
|
forwards POST requests to an upstream MCP server, rejects GET with 405, and
|
|
7
7
|
emits per-capability analytics on every call.
|
|
8
|
+
applies_to:
|
|
9
|
+
product: gateway
|
|
10
|
+
hosting: all
|
|
8
11
|
---
|
|
9
12
|
|
|
10
13
|
`McpProxyHandler` is the route handler that backs every MCP Gateway route. It
|
|
@@ -5,6 +5,9 @@ description:
|
|
|
5
5
|
Front many upstream MCP servers from one Zuplo project. Share a single OAuth
|
|
6
6
|
policy across every route, add one token exchange policy per upstream, and let
|
|
7
7
|
each user maintain independent per-upstream connections.
|
|
8
|
+
applies_to:
|
|
9
|
+
product: gateway
|
|
10
|
+
hosting: all
|
|
8
11
|
---
|
|
9
12
|
|
|
10
13
|
A single Zuplo deployment can front any number of upstream MCP servers. One
|
|
@@ -5,6 +5,9 @@ description:
|
|
|
5
5
|
Wire up the Zuplo MCP Gateway in routes.oas.json and policies.json — register
|
|
6
6
|
the runtime plugin, configure one OAuth policy and one token-exchange policy
|
|
7
7
|
per upstream, and add an MCP route.
|
|
8
|
+
applies_to:
|
|
9
|
+
product: gateway
|
|
10
|
+
hosting: all
|
|
8
11
|
---
|
|
9
12
|
|
|
10
13
|
To turn any Zuplo project into an MCP Gateway, configure four things in source
|
|
@@ -5,6 +5,9 @@ description:
|
|
|
5
5
|
Connect ChatGPT to a Zuplo MCP Gateway as a custom app using Developer Mode,
|
|
6
6
|
scan the gateway tools, complete the OAuth flow, and use the app in
|
|
7
7
|
conversation.
|
|
8
|
+
applies_to:
|
|
9
|
+
product: gateway
|
|
10
|
+
hosting: all
|
|
8
11
|
---
|
|
9
12
|
|
|
10
13
|
ChatGPT connects to remote MCP servers as **custom apps**. OpenAI previously
|
|
@@ -5,6 +5,9 @@ description:
|
|
|
5
5
|
Connect Claude Code's CLI to a Zuplo MCP Gateway using `claude mcp add`,
|
|
6
6
|
authenticate over OAuth, and manage the connection from the `/mcp` slash
|
|
7
7
|
command.
|
|
8
|
+
applies_to:
|
|
9
|
+
product: gateway
|
|
10
|
+
hosting: all
|
|
8
11
|
---
|
|
9
12
|
|
|
10
13
|
[Claude Code](https://code.claude.com/) is Anthropic's command-line coding
|
|
@@ -4,6 +4,9 @@ sidebar_label: "Claude Desktop"
|
|
|
4
4
|
description:
|
|
5
5
|
Connect Claude Desktop or Claude.ai to a Zuplo MCP Gateway as a custom remote
|
|
6
6
|
connector, complete the OAuth flow, and start using your tools.
|
|
7
|
+
applies_to:
|
|
8
|
+
product: gateway
|
|
9
|
+
hosting: all
|
|
7
10
|
---
|
|
8
11
|
|
|
9
12
|
Claude Desktop and Claude.ai connect to remote MCP servers through **Custom
|
|
@@ -5,6 +5,9 @@ description:
|
|
|
5
5
|
Connect Cursor to a Zuplo MCP Gateway using a one-click deeplink or by editing
|
|
6
6
|
`mcp.json` directly, complete the OAuth flow, and use gateway tools in Cursor
|
|
7
7
|
Composer.
|
|
8
|
+
applies_to:
|
|
9
|
+
product: gateway
|
|
10
|
+
hosting: all
|
|
8
11
|
---
|
|
9
12
|
|
|
10
13
|
[Cursor](https://cursor.com/) is an AI-first code editor. It speaks the MCP
|
|
@@ -4,6 +4,9 @@ sidebar_label: "Other clients"
|
|
|
4
4
|
description:
|
|
5
5
|
Add a Zuplo MCP Gateway to Windsurf, Goose, Gemini CLI, GitHub Copilot CLI,
|
|
6
6
|
Postman, MCPJam, Continue, LibreChat, and JetBrains AI Assistant.
|
|
7
|
+
applies_to:
|
|
8
|
+
product: gateway
|
|
9
|
+
hosting: all
|
|
7
10
|
---
|
|
8
11
|
|
|
9
12
|
The Zuplo MCP Gateway works with any MCP client that speaks the Streamable HTTP
|
|
@@ -5,6 +5,9 @@ description:
|
|
|
5
5
|
Learn how MCP clients connect to a Zuplo MCP Gateway, where to find the
|
|
6
6
|
connection URL, what the OAuth flow looks like on first use, and which clients
|
|
7
7
|
support which spec features.
|
|
8
|
+
applies_to:
|
|
9
|
+
product: gateway
|
|
10
|
+
hosting: all
|
|
8
11
|
---
|
|
9
12
|
|
|
10
13
|
The Zuplo MCP Gateway exposes each MCP route at a stable HTTPS URL that any
|
|
@@ -5,6 +5,9 @@ description:
|
|
|
5
5
|
Connect VS Code with GitHub Copilot to a Zuplo MCP Gateway through
|
|
6
6
|
`.vscode/mcp.json`, the `code --add-mcp` CLI, or the Extensions view, and use
|
|
7
7
|
gateway tools in Copilot Chat's Agent mode.
|
|
8
|
+
applies_to:
|
|
9
|
+
product: gateway
|
|
10
|
+
hosting: all
|
|
8
11
|
---
|
|
9
12
|
|
|
10
13
|
VS Code with GitHub Copilot connects to remote MCP servers and exposes their
|
|
@@ -6,6 +6,9 @@ description: |
|
|
|
6
6
|
(ID-JAG) are, the problem they solve for AI agents and MCP, and how the Zuplo
|
|
7
7
|
MCP Gateway performs the token exchange so your MCP servers and clients don't
|
|
8
8
|
have to.
|
|
9
|
+
applies_to:
|
|
10
|
+
product: gateway
|
|
11
|
+
hosting: all
|
|
9
12
|
---
|
|
10
13
|
|
|
11
14
|
Cross App Access (XAA) lets one application reach another application's API on a
|
|
@@ -5,6 +5,9 @@ description: |
|
|
|
5
5
|
Every configuration option for Cross App Access (XAA) on the Zuplo MCP Gateway
|
|
6
6
|
— the id-jag mode on the token-exchange policy, where the gateway acts as the
|
|
7
7
|
XAA requesting app.
|
|
8
|
+
applies_to:
|
|
9
|
+
product: gateway
|
|
10
|
+
hosting: all
|
|
8
11
|
---
|
|
9
12
|
|
|
10
13
|
Cross App Access is configured on the
|
|
@@ -6,6 +6,9 @@ description: |
|
|
|
6
6
|
Zuplo Portal — no repository to clone. The gateway fronts Okta's hosted
|
|
7
7
|
xaa.dev Todo0 server and performs the Cross App Access (XAA) token exchange on
|
|
8
8
|
every request.
|
|
9
|
+
applies_to:
|
|
10
|
+
product: gateway
|
|
11
|
+
hosting: all
|
|
9
12
|
---
|
|
10
13
|
|
|
11
14
|
This quickstart builds a working Cross App Access (XAA) gateway entirely in the
|
|
@@ -4,6 +4,9 @@ sidebar_label: "How it works"
|
|
|
4
4
|
description:
|
|
5
5
|
Architecture overview — request lifecycle, the two OAuth surfaces, the
|
|
6
6
|
Streamable HTTP transport, and the configuration model.
|
|
7
|
+
applies_to:
|
|
8
|
+
product: gateway
|
|
9
|
+
hosting: all
|
|
7
10
|
---
|
|
8
11
|
|
|
9
12
|
The MCP Gateway is a set of policies and a route handler that run inside any
|
|
@@ -5,6 +5,9 @@ description:
|
|
|
5
5
|
Front an MCP server that authenticates with a static API key over a Bearer
|
|
6
6
|
token. Configure a custom upstream in the wizard, strip the inbound auth
|
|
7
7
|
token, and inject the upstream key with the Add or Set Request Headers policy.
|
|
8
|
+
applies_to:
|
|
9
|
+
product: gateway
|
|
10
|
+
hosting: all
|
|
8
11
|
---
|
|
9
12
|
|
|
10
13
|
Not every upstream MCP server uses OAuth. Many authenticate with a static API
|
|
@@ -5,6 +5,9 @@ description:
|
|
|
5
5
|
Attach the mcp-token-exchange-inbound policy to an MCP route so the Zuplo MCP
|
|
6
6
|
Gateway authenticates each user against an OAuth-protected upstream MCP
|
|
7
7
|
server.
|
|
8
|
+
applies_to:
|
|
9
|
+
product: gateway
|
|
10
|
+
hosting: all
|
|
8
11
|
---
|
|
9
12
|
|
|
10
13
|
When an upstream MCP server requires OAuth — either per user or as a shared
|
|
@@ -5,6 +5,9 @@ description:
|
|
|
5
5
|
Restrict and re-project the tools, prompts, resources, and resource templates
|
|
6
6
|
a Zuplo MCP Gateway route exposes from its upstream MCP server by configuring
|
|
7
7
|
the mcp-capability-filter-inbound policy in code.
|
|
8
|
+
applies_to:
|
|
9
|
+
product: gateway
|
|
10
|
+
hosting: all
|
|
8
11
|
---
|
|
9
12
|
|
|
10
13
|
<CurateToolsPicker
|
|
@@ -4,6 +4,9 @@ sidebar_label: "Analytics"
|
|
|
4
4
|
description:
|
|
5
5
|
What events the Zuplo MCP Gateway emits, the dimensions you'll filter by, and
|
|
6
6
|
the kinds of operational questions the analytics dashboard answers.
|
|
7
|
+
applies_to:
|
|
8
|
+
product: gateway
|
|
9
|
+
hosting: all
|
|
7
10
|
---
|
|
8
11
|
|
|
9
12
|
Every authenticated MCP request the Zuplo MCP Gateway handles produces a set of
|
|
@@ -5,6 +5,9 @@ description:
|
|
|
5
5
|
How the Zuplo MCP Gateway logs — structured event-keyed entries with
|
|
6
6
|
auto-attached route and subject fields, what the gateway intentionally
|
|
7
7
|
excludes, and how the logs cross-reference analytics events.
|
|
8
|
+
applies_to:
|
|
9
|
+
product: gateway
|
|
10
|
+
hosting: all
|
|
8
11
|
---
|
|
9
12
|
|
|
10
13
|
The Zuplo MCP Gateway emits structured logs alongside its analytics events. Each
|
|
@@ -5,6 +5,9 @@ description:
|
|
|
5
5
|
Overview of the Zuplo MCP Gateway — a single OAuth-protected MCP endpoint that
|
|
6
6
|
fronts multiple upstream MCP servers with curated tools and per-call
|
|
7
7
|
analytics.
|
|
8
|
+
applies_to:
|
|
9
|
+
product: gateway
|
|
10
|
+
hosting: all
|
|
8
11
|
---
|
|
9
12
|
|
|
10
13
|
The Zuplo MCP Gateway fronts one or more remote
|
|
@@ -4,6 +4,9 @@ sidebar_label: "Reference"
|
|
|
4
4
|
description:
|
|
5
5
|
URL catalog, OAuth scopes, default TTLs, required headers, and configuration
|
|
6
6
|
constants for the Zuplo MCP Gateway.
|
|
7
|
+
applies_to:
|
|
8
|
+
product: gateway
|
|
9
|
+
hosting: all
|
|
7
10
|
---
|
|
8
11
|
|
|
9
12
|
This page is the lookup table for facts about the gateway — every URL it
|
|
@@ -5,6 +5,9 @@ description:
|
|
|
5
5
|
The read-only MCP Server Registry API (v0.1) the gateway serves by default —
|
|
6
6
|
advertises every MCP route so clients and subregistries can discover them
|
|
7
7
|
without authentication.
|
|
8
|
+
applies_to:
|
|
9
|
+
product: gateway
|
|
10
|
+
hosting: all
|
|
8
11
|
---
|
|
9
12
|
|
|
10
13
|
The MCP Gateway serves a read-only
|
|
@@ -5,6 +5,9 @@ description:
|
|
|
5
5
|
Use the MCP Inspector and MCPJam Inspector to manually exercise your Zuplo MCP
|
|
6
6
|
Gateway routes — walk the OAuth flow, list tools, call them, and inspect every
|
|
7
7
|
JSON-RPC message.
|
|
8
|
+
applies_to:
|
|
9
|
+
product: gateway
|
|
10
|
+
hosting: all
|
|
8
11
|
---
|
|
9
12
|
|
|
10
13
|
A regular MCP client like Claude Desktop or Cursor is great for using a gateway,
|
|
@@ -4,6 +4,9 @@ sidebar_label: "Troubleshooting"
|
|
|
4
4
|
description:
|
|
5
5
|
Symptoms, likely causes, and fixes for the issues most commonly hit when
|
|
6
6
|
setting up or running the Zuplo MCP Gateway.
|
|
7
|
+
applies_to:
|
|
8
|
+
product: gateway
|
|
9
|
+
hosting: all
|
|
7
10
|
---
|
|
8
11
|
|
|
9
12
|
This page covers the issues people hit most often with the MCP Gateway,
|
|
@@ -6,6 +6,9 @@ description:
|
|
|
6
6
|
that returns 200 while the client errors, and invalid-argument rejections —
|
|
7
7
|
using debug logging, the structured-content configuration, and the tool's
|
|
8
8
|
advertised input schema.
|
|
9
|
+
applies_to:
|
|
10
|
+
product: gateway
|
|
11
|
+
hosting: all
|
|
9
12
|
---
|
|
10
13
|
|
|
11
14
|
When an AI client calls a tool exposed by the
|
package/docs/policies/_index.md
CHANGED
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
| ai-gateway-configuration-executor-inbound | AI Gateway Configuration Executor | Loads the app configuration for the request (when auth or the configuration loader has not already), runs the inbound policy chain from that configuration, and enforces limits inherited from parent teams or the gateway root. Place this policy on AI Gateway routes after optional authentication and optional `ai-gateway-configuration-loader-inbound`. When either of those already populated the app-configuration channel, this policy reuses it. Otherwise it loads the configuration with the route's `app_id` path parameter. Applications select from policies pre-declared by the gateway. Applications without a `inboundPolicyChain`, or with an empty chain, run no application-selected policies. Entry options replace the declaration's options as a complete object; omit them to inherit the declaration, including environment-backed credentials. Each occurrence receives a private deep copy of its entry options, so a policy mutating its options cannot corrupt the cached app configuration. | ai-gateway |
|
|
9
9
|
| ai-gateway-configuration-loader-inbound | AI Gateway Configuration Loader | Loads the AI Gateway app configuration for the request into the request-scoped channel and does nothing else. Place this policy on AI Gateway routes before `ai-gateway-configuration-executor-inbound` when you want configuration loading separated from chain execution. When `ai-gateway-auth-inbound` already populated the channel, this policy reuses it. Otherwise it loads the configuration with the route's `app_id` path parameter. If this policy is omitted, the configuration executor still loads configuration itself before running the application chain. | ai-gateway |
|
|
10
10
|
| ai-gateway-fallback-model-inbound | AI Gateway Fallback Model | Adds failure and quota fallbacks to an existing AI Gateway model selection. Place this policy after AI Gateway Model Filtering. It never creates a model selection, so a misplaced policy cannot bypass filtering. | ai-gateway |
|
|
11
|
-
| ai-gateway-metering-inbound | AI Gateway Metering | Meters AI Gateway usage for the application. The
|
|
11
|
+
| ai-gateway-metering-inbound | AI Gateway Metering | Meters AI Gateway usage for the application. The policy seeds the request's baseline increments for analytics and claims metering for the request so a repeated chain entry cannot count it twice. Usage is recorded in request analytics. Budgets are declared with `budgetRules` and enforced by the configuration executor through Gateway Service. The authentication policy must run before this policy so the app configuration is available. | ai-gateway |
|
|
12
12
|
| ai-gateway-model-filtering-inbound | AI Gateway Model Filtering | Matches AI Gateway requests against curated allow lists or open block lists, then stores the winning model reference for the route handler. | ai-gateway |
|
|
13
13
|
| ai-gateway-model-override-inbound | AI Gateway Model Override | Forces one model for every request, or supplies a default model when a request omits one, then stores that selection for the AI Gateway handler. An earlier policy's model selection is never overwritten, so a custom routing policy placed before this one stays authoritative. | ai-gateway |
|
|
14
14
|
| ai-gateway-semantic-cache-inbound | AI Gateway Semantic Cache | AI Gateway Semantic Cache policy. This inbound policy looks up the semantic cache on entry and, on a miss, registers a response-sending hook to write the upstream response back into the cache. Caching parameters (semanticTolerance, expirationSecondsTtl, namespace, recentMessageCount) come from the policy options, and presence in the route's chain is what enables it. An id from the authenticated app configuration always provides the cache namespace so application-supplied options cannot cross tenant partitions. The cache key covers the system prompt plus the last `recentMessageCount` messages (default 1) — applied when storing and when matching — so multi-turn conversations can hit entries cached from earlier, shorter ones. Cache outcomes are reported on the response via the RFC 9211 `Cache-Status` header under the cache name `zp-aigw-sem-cache` (hit: `zp-aigw-sem-cache; hit; detail="similarity=0.93"`; miss: `zp-aigw-sem-cache; fwd=miss; stored`). Responses also include the `x-ai-gateway-cache: HIT\|MISS` and `x-ai-gateway-cache-similarity` headers. | ai-gateway |
|
|
@@ -14,8 +14,7 @@ fallback model or returns `429 Too Many Requests`. Cached responses are also
|
|
|
14
14
|
subject to budgets: a blocked cache hit returns `429 Too Many Requests` without
|
|
15
15
|
using a fallback model.
|
|
16
16
|
|
|
17
|
-
Place Metering after Model Filtering
|
|
18
|
-
hits count toward request limits.
|
|
17
|
+
Place Metering after Model Filtering and before Semantic Cache.
|
|
19
18
|
|
|
20
19
|
## Example
|
|
21
20
|
|
|
@@ -23,7 +22,6 @@ hits count toward request limits.
|
|
|
23
22
|
{
|
|
24
23
|
"name": "ai-gateway-metering-inbound",
|
|
25
24
|
"options": {
|
|
26
|
-
"throwOnFailure": false,
|
|
27
25
|
"budgetRules": [
|
|
28
26
|
{
|
|
29
27
|
"budgetBy": "app",
|
|
@@ -241,7 +239,8 @@ Budget changes can take time to take effect. Usage is recorded asynchronously,
|
|
|
241
239
|
so concurrent requests can exceed a budget before further requests are blocked.
|
|
242
240
|
|
|
243
241
|
If a budget check is unavailable, requests can proceed unless a budget has
|
|
244
|
-
already been determined to block them.
|
|
245
|
-
|
|
246
|
-
|
|
247
|
-
|
|
242
|
+
already been determined to block them.
|
|
243
|
+
|
|
244
|
+
The `throwOnFailure` option is deprecated and has no effect. This policy no
|
|
245
|
+
longer calls the metering service, so it has no failure to throw on. Usage is
|
|
246
|
+
recorded in analytics, and budgets are checked by the gateway.
|
|
@@ -9,6 +9,5 @@ expression its own budget, such as one budget per user with
|
|
|
9
9
|
`request.headers.get("x-user-id")`.
|
|
10
10
|
|
|
11
11
|
Place it after Model Filtering and before policies such as Semantic Cache that
|
|
12
|
-
may answer without calling a provider.
|
|
13
|
-
|
|
14
|
-
instead.
|
|
12
|
+
may answer without calling a provider. Budget checks fail open when the budget
|
|
13
|
+
service is unavailable.
|
|
@@ -12,7 +12,7 @@
|
|
|
12
12
|
"requiresAI": true,
|
|
13
13
|
"policyType": "ai-gateway-metering",
|
|
14
14
|
"products": ["ai-gateway"],
|
|
15
|
-
"description": "Meters AI Gateway usage for the application.\n\nThe
|
|
15
|
+
"description": "Meters AI Gateway usage for the application.\n\nThe policy seeds the request's baseline increments for analytics and claims metering for the request so a repeated chain entry cannot count it twice. Usage is recorded in request analytics. Budgets are declared with `budgetRules` and enforced by the configuration executor through Gateway Service.\n\nThe authentication policy must run before this policy so the app configuration is available.",
|
|
16
16
|
"deprecatedMessage": "",
|
|
17
17
|
"required": ["handler"],
|
|
18
18
|
"properties": {
|
|
@@ -55,15 +55,17 @@
|
|
|
55
55
|
}
|
|
56
56
|
]
|
|
57
57
|
}
|
|
58
|
-
]
|
|
59
|
-
"throwOnFailure": false
|
|
58
|
+
]
|
|
60
59
|
}
|
|
61
60
|
],
|
|
62
61
|
"properties": {
|
|
63
62
|
"throwOnFailure": {
|
|
64
63
|
"type": "boolean",
|
|
65
64
|
"default": false,
|
|
66
|
-
"
|
|
65
|
+
"deprecated": true,
|
|
66
|
+
"doNotSuggest": true,
|
|
67
|
+
"x-advanced": true,
|
|
68
|
+
"description": "Deprecated and has no effect. This policy no longer calls the metering service, so there is no failure to throw on."
|
|
67
69
|
},
|
|
68
70
|
"budgetRules": {
|
|
69
71
|
"type": "array",
|
|
@@ -372,8 +374,7 @@
|
|
|
372
374
|
}
|
|
373
375
|
]
|
|
374
376
|
}
|
|
375
|
-
]
|
|
376
|
-
"throwOnFailure": false
|
|
377
|
+
]
|
|
377
378
|
}
|
|
378
379
|
}
|
|
379
380
|
]
|
|
@@ -1,6 +1,16 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: Gateway Environment Variables
|
|
3
3
|
sidebar_label: Environment Variables
|
|
4
|
+
applies_to:
|
|
5
|
+
product: gateway
|
|
6
|
+
hosting: all
|
|
7
|
+
differs:
|
|
8
|
+
managed-dedicated: >-
|
|
9
|
+
`ZUPLO_ENVIRONMENT_TYPE` values depend on the hosting environment, so
|
|
10
|
+
check for the values your deployment reports instead of assuming `edge`.
|
|
11
|
+
self-hosted: >-
|
|
12
|
+
`ZUPLO_ENVIRONMENT_TYPE` values depend on the hosting environment, so
|
|
13
|
+
check for the values your deployment reports instead of assuming `edge`.
|
|
4
14
|
---
|
|
5
15
|
|
|
6
16
|
Your API gateway can read every environment variable set for its environment,
|