llms.txt
# Metorial
> The open-source MCP and skills gateway for your whole company. Metorial gives every employee, agent, and AI client one governed place to connect the tools and skills they need, with access control, audit logs, and tracing.
Every documentation page is available as markdown by appending `.mdx` to its URL.
## Metorial site
- [MCP gateway](https://metorial.com/mcp-gateway): the product overview, setup per AI client, and a gateway comparison.
- [Integrations](https://metorial.com/integrations): 1,000+ MCP servers, each with its tools and setup.
- [AI clients](https://metorial.com/agents/list): how to connect Claude, ChatGPT, Cursor and more.
- [Comparisons](https://metorial.com/comparisons): Metorial versus other MCP and AI gateways.
- [Scenarios](https://metorial.com/scenarios): worked examples of agents using real tools.
- [Pricing](https://metorial.com/pricing): plans, what is free, and what costs extra.
- [Security](https://metorial.com/security): access control, audit logs, and compliance.
- [Answers for AI crawlers](https://metorial.com/for-ai-crawlers/llms.txt): short, source-backed answers about MCP and AI gateways.
## Build
- [Getting started with the API](https://metorial.com/docs/build/api.mdx): Learn how to use the Metorial API, get your API keys, and make your first request
- [Glossary](https://metorial.com/docs/build/glossary.mdx): Definitions for Metorial organizations, providers, sessions, identities, consumers, and related concepts.
- [Developer quickstart](https://metorial.com/docs/build/quickstart.mdx): Get up and running with Metorial in under 5 minutes
- [Custom providers](https://metorial.com/docs/build/custom-providers.mdx): Deploy your own MCP server code on Metorial.
- [Deploying custom providers](https://metorial.com/docs/build/custom-providers/managed-deployment.mdx): Learn how to deploy and manage versions of your custom providers.
- [Getting started with custom providers](https://metorial.com/docs/build/custom-providers/managed-quickstart.mdx): Deploy custom MCP server code without managing infrastructure.
- [Using with AI SDK](https://metorial.com/docs/build/providers/ai-sdk.mdx): Use Metorial with Vercel AI SDK (recommended for TypeScript)
- [Using with Anthropic](https://metorial.com/docs/build/providers/anthropic.mdx): Use Metorial with Claude models
- [Using with Google](https://metorial.com/docs/build/providers/google.mdx): Use Metorial with Google Gemini models
- [Provider runtime](https://metorial.com/docs/build/providers.mdx): Metorial works with all major AI providers
- [OpenAI-compatible providers](https://metorial.com/docs/build/providers/openai-compatible.mdx): Use Metorial with DeepSeek, TogetherAI, XAI, and other OpenAI-compatible APIs
- [Using with OpenAI](https://metorial.com/docs/build/providers/openai.mdx): Use Metorial with OpenAI GPT models
- [Use providers with SDKs](https://metorial.com/docs/build/providers/with-sdks.mdx): Connect Metorial provider tools to an LLM and build a chat-enabled app.
- [Code review bot with GitHub](https://metorial.com/docs/build/samples/code-review-bot.mdx): Create an AI-powered bot that analyzes pull requests for security issues, code smells, and style violations
- [HR interview coordinator](https://metorial.com/docs/build/samples/interview-coordinator-bot.mdx): Learn how to build an AI agent that schedules interviews, sends professional emails, and coordinates with your team using Google Calendar and Gmail
- [PM Slack standup bot](https://metorial.com/docs/build/samples/slack-standup-bot.mdx): Create an AI-powered bot that collects daily standup responses, analyzes team progress, and posts executive summaries
- [Connect with the CLI](https://metorial.com/docs/build/sandboxes/connect-cli.mdx): Open a shell, run commands, and move files from your terminal.
- [Connect with the SDK](https://metorial.com/docs/build/sandboxes/connect-sdk.mdx): Run commands, stream output, manage files, and call ports from your code.
- [Custom images](https://metorial.com/docs/build/sandboxes/custom-images.mdx): Build a machine image from your own Dockerfile.
- [Disks](https://metorial.com/docs/build/sandboxes/disks.mdx): Store data that outlives a machine, and grow a machine's storage.
- [Sandboxes](https://metorial.com/docs/build/sandboxes.mdx): Give your agents isolated Linux machines to run code, store files, and serve apps.
- [Lifecycle, pausing, and hibernation](https://metorial.com/docs/build/sandboxes/lifecycle.mdx): Control when sandbox machines pause or hibernate, and run hooks on every transition.
- [Configure a machine](https://metorial.com/docs/build/sandboxes/machines.mdx): Set the size, region, environment, and startup commands of a sandbox machine.
- [Monitoring and debugging](https://metorial.com/docs/build/sandboxes/monitoring.mdx): Read console logs, trace what happened to a machine, find out why it failed, and track resource usage.
- [Networking](https://metorial.com/docs/build/sandboxes/networking.mdx): Expose ports with access tokens or publicly, and restrict outbound traffic with firewalls.
- [Run your first machine](https://metorial.com/docs/build/sandboxes/quickstart.mdx): Create a sandbox machine, run a command in it, and clean up.
- [Connection wire protocol](https://metorial.com/docs/build/sandboxes/wire-protocol.mdx): Connect to machines from any language over WebSockets and HTTPS.
- [Error handling](https://metorial.com/docs/build/sdk/error-handling.mdx): Handle errors gracefully in your Metorial SDK applications
- [JavaScript SDK](https://metorial.com/docs/build/sdk/javascript.mdx): Learn how to use the Metorial JavaScript SDK for TypeScript and JavaScript applications
- [OAuth](https://metorial.com/docs/build/sdk/oauth.mdx): Handle user authorization for OAuth-enabled providers using Provider Setup Sessions
- [Python SDK](https://metorial.com/docs/build/sdk/python.mdx): Learn how to use the Metorial Python SDK for Python applications
- [Organizations, projects, and environments](https://metorial.com/docs/build/operate/organizations-and-projects.mdx): How Metorial organizes teams, applications, and isolated environments.
- [Providers](https://metorial.com/docs/build/operate/providers.mdx): Providers are catalog or custom integrations you connect to Metorial. Understanding integrations, Magic MCP servers, configs, auth configs, and provider deployments lets you control exactly how each provider is configured and authenticated.
- [Sessions](https://metorial.com/docs/build/operate/sessions.mdx): Sessions are the runtime layer that connects your application to one or more providers. Each session gives your AI access to tools from all the providers attached to it.
## Platform
- [Core concepts](https://metorial.com/docs/platform/get-started/core-concepts.mdx): Understand how Workforce connects AI agents and applications to user-authorized tools through portals, integrations, skills, MCP URLs, and activity logs.
- [Dashboard tour](https://metorial.com/docs/platform/get-started/dashboard-tour.mdx): A product tour of the Metorial dashboard: Workforce, Portals, Skills, Integrations, Magic MCP, activity, and settings.
- [Get started with Metorial](https://metorial.com/docs/platform/get-started.mdx): Let your team connect AI agents and MCP clients like Cursor, ChatGPT, and Claude to approved apps, tools, and shared skills, with access controls and activity logs.
- [Preview portal access](https://metorial.com/docs/platform/get-started/preview-portal-access.mdx): Preview the employee portal and confirm users can see the right integrations and skills.
- [Create custom OAuth credentials](https://metorial.com/docs/platform/integrations/create-custom-oauth-credentials.mdx): Connect an OAuth app that you manage and choose the permissions it can use.
- [Create an integration](https://metorial.com/docs/platform/integrations/create-integration.mdx): Create a reusable integration and control which tools it can use.
- [Integrations](https://metorial.com/docs/platform/integrations.mdx): Connect the tools your users authorize, control which tools each integration can use, and trace every call.
- [Link a remote MCP server](https://metorial.com/docs/platform/integrations/link-remote-mcp-server.mdx): Connect a remote MCP server to Metorial.
- [Review connection logs](https://metorial.com/docs/platform/integrations/review-connection-logs.mdx): Trace session activity and inspect individual tool calls in the dashboard.
- [Set up a Magic MCP server](https://metorial.com/docs/platform/integrations/setup-magic-mcp-server.mdx): Create a Magic MCP server and check it in Metorial Explorer.
- [Use Metorial Explorer](https://metorial.com/docs/platform/integrations/use-metorial-explorer.mdx): Connect a provider and test its tools in Metorial Explorer.
- [Grant Workforce access](https://metorial.com/docs/platform/workforce/grant-access.mdx): Use groups to control access to integrations and skills in Workforce.
- [Workforce](https://metorial.com/docs/platform/workforce.mdx): Workforce is the control plane for connecting AI agents and applications to user-authorized integrations, skills, portals, and MCP URLs.
- [Inspect Workforce agents](https://metorial.com/docs/platform/workforce/inspect-agents.mdx): Review agent details, tool calls, and connection activity in Workforce.
- [Magic Skills](https://metorial.com/docs/platform/workforce/magic-skills.mdx): Magic Skills package repeatable workflows so teams can publish and govern useful agent work.
- [Manage Workforce accounts](https://metorial.com/docs/platform/workforce/manage-accounts.mdx): Invite people, review their access, and inspect their Workforce activity.
- [Portals](https://metorial.com/docs/platform/workforce/portals.mdx): Portals are branded places where users discover and connect approved integrations, skills, and MCP access.
## API Reference
- [Providers](https://metorial.com/api/providers): A provider is a read-only template for an MCP server integration (like GitHub or Slack). To use a provider, create a deployment from it.
- [Provider Versions](https://metorial.com/api/provider-versions): A version is a specific release of a provider (e.g., v1.2.0). Each version has its own tools, auth methods, and config schema. Deployments are pinned to a version for security reasons.
- [Provider Specifications](https://metorial.com/api/provider-specifications): A specification defines what a provider version can do: its tools, auth methods, and required configuration fields.
- [Provider Triggers](https://metorial.com/api/provider-triggers): A provider trigger describes an event source a provider can emit for callbacks. Use triggers to discover which callback subscriptions a provider version supports.
- [Provider Tools](https://metorial.com/api/provider-tools): A tool is a single action a provider can perform like 'search_issues' or 'send_message'. Tools are what AI agents call via MCP. By default, tools from the latest provider version are returned. Use the optional version filter to get tools for a specific version.
- [Provider Auth Methods](https://metorial.com/api/provider-auth-methods): An auth method defines one way to authenticate with a provider (OAuth, API token, or custom credentials). A provider version may support multiple auth methods.
- [Integrations](https://metorial.com/api/integrations): Integrations define reusable provider contracts that can then be materialized into integration instances.
- [Integration Providers](https://metorial.com/api/integration-providers): Integration providers define the shared provider-level contract for a given integration.
- [Integration Setup Sessions](https://metorial.com/api/integration-setup-sessions): Integration setup sessions orchestrate configuring every provider required by an integration instance.
- [Integration Instances](https://metorial.com/api/integration-instances): Integration instances materialize an integration for a specific actor, identity, or runtime configuration.
- [Integration Instance Providers](https://metorial.com/api/integration-instance-providers): Integration instance providers resolve the effective per-instance provider materialization for an integration.
- [Integration Instance Groups](https://metorial.com/api/integration-instance-groups): Integration instance groups combine instance providers into a grouped routed configuration.
- [Integration Instance Group Providers](https://metorial.com/api/integration-instance-group-providers): Integration instance group providers define the effective routed provider set for an integration instance group.
- [Sessions](https://metorial.com/api/sessions): Sessions are connections to providers that allow clients to interact with MCP servers. Each session can include one or more provider deployments.
- [Session Templates](https://metorial.com/api/session-templates): Session templates define reusable configurations for sessions, including which providers to include. Templates can be used to quickly create new sessions with consistent settings.
- [Session Template Providers](https://metorial.com/api/session-template-providers): Session template providers define which providers should be included when a session is created from a template.
- [Session Providers](https://metorial.com/api/session-providers): Session providers represent the providers that are actively connected to a session. Each session can have multiple providers, and providers can be added or removed during the session lifecycle.
- [Session Participants](https://metorial.com/api/session-participants): Session participants represent the clients and other entities that are connected to a session. This read-only resource tracks who is participating in a session.
- [Session Errors](https://metorial.com/api/session-errors): Session errors track errors that occurred during a session. This read-only resource provides visibility into issues that happened during provider execution.
- [Provider Runs](https://metorial.com/api/provider-runs): Provider runs track the execution of provider operations within a session. This read-only resource provides visibility into provider activity.
- [Session Messages](https://metorial.com/api/session-messages): Session messages represent the MCP protocol messages exchanged during a session. This read-only resource provides visibility into the communication between clients and providers.
- [Session Connections](https://metorial.com/api/session-connections): Session connections represent the MCP connections established within a session. This read-only resource provides visibility into the connection state and capabilities.
- [Tool Calls](https://metorial.com/api/tool-calls): Tool calls represent individual tool invocations within a session. They track the input, output, and status of each tool execution.
- [Skill Configurations](https://metorial.com/api/skill-configurations): Manage configuration profiles for skill execution.
- [Skills](https://metorial.com/api/skills): Skills group provider and integration capabilities into reusable, owned compositions.
- [Skill Agents](https://metorial.com/api/skill-agents): Manage sub-agents attached to a skill.
- [Skill Groups](https://metorial.com/api/skill-groups): Skill groups organize skills into reusable collections.
- [Skill Group Items](https://metorial.com/api/skill-group-items): Skill group items link groups to skills.
- [Skill Items](https://metorial.com/api/skill-items): Skill items attach integrations and providers to skills.
- [Skill Participants](https://metorial.com/api/skill-participants): Inspect participants associated with an instance skill.
- [Skill Templates](https://metorial.com/api/skill-templates): Skill templates define reusable starting points for skills.
- [Skill Template Items](https://metorial.com/api/skill-template-items): Skill template items link template definitions to provider and integration items.
- [Skill Versions](https://metorial.com/api/skill-versions): Inspect version history and snapshots for a skill.
- [Skill Exports](https://metorial.com/api/skill-exports): Export skills, skill plugins, and skill marketplaces as zip files.
- [Skill Imports](https://metorial.com/api/skill-imports): Import skills from public repositories or uploaded files.
- [Skill Marketplaces](https://metorial.com/api/skill-marketplaces): Manage skill marketplaces for an instance.
- [Skill Marketplace Plugins](https://metorial.com/api/skill-marketplace-plugins): Manage plugin links for skill marketplaces.
- [Skill Plugins](https://metorial.com/api/skill-plugins): Manage skill plugins for an instance.
- [Skill Plugin Skills](https://metorial.com/api/skill-plugin-skills): Manage skill links for skill plugins.
- [Provider Deployments](https://metorial.com/api/provider-deployments): A deployment is a running instance of a provider, pinned to a specific version. Deployments support custom configuration values and user authentication.
- [Provider Configs](https://metorial.com/api/provider-configs): A config holds settings for a deployment, like API endpoints or feature flags. Create configs with values directly, or from a saved config vault with pre-saved values.
- [Provider Config Vaults](https://metorial.com/api/provider-config-vaults): A config vault is a saved, reusable set of configuration values. Use vaults to store credentials once and apply them to multiple deployments without re-entering.
- [Provider Auth Configs](https://metorial.com/api/provider-auth-configs): An auth config is a user's authenticated connection to a provider. Created when a user completes OAuth or manually enters an API token.
- [Provider Auth Credentials](https://metorial.com/api/provider-auth-credentials): Auth credentials store your OAuth app registration (client ID, client secret, and scopes). These are the app-level credentials you get from a service like GitHub or Slack.
- [Provider Setup Sessions](https://metorial.com/api/provider-setup-sessions): A setup session tracks an in-progress OAuth flow, storing state during the redirect. On success, it creates an auth config with the user's access token.
- [Provider Auth Imports](https://metorial.com/api/provider-auth-imports): An auth import lets you bring in existing OAuth tokens or credentials from another system, so users don't need to re-authenticate to use Metorial.
- [Provider Auth Exports](https://metorial.com/api/provider-auth-exports): An auth export lets you extract OAuth tokens or credentials from Metorial to use in other systems, avoiding duplicate authentication flows.
- [Portal](https://metorial.com/api/portal): Use Portals to create custom branded MCP server marketplaces for your organization.
- [Portal Access](https://metorial.com/api/portal-access): Manage which consumer groups can access portal provider templates and MCP servers.
- [Portal Listings](https://metorial.com/api/portal-listings): Read the shared listings available on a portal surface.
- [Portal Access Requests](https://metorial.com/api/portal-access-requests): Review and resolve access requests for a portal.
- [Portal Consumer Groups](https://metorial.com/api/portal-consumer-groups): Manage the consumer groups that drive portal visibility and access rules.
- [Portal Consumer Profiles](https://metorial.com/api/portal-consumer-profiles): Manage the consumers and effective group assignments for a portal.
- [Portal Consumer Invites](https://metorial.com/api/portal-consumer-invites): List and inspect consumer invites for a portal.
- [Custom Providers](https://metorial.com/api/custom-providers): Custom providers allow you to deploy your own MCP servers. Create providers from container images, remote URLs, or serverless functions.
- [Custom Provider Versions](https://metorial.com/api/custom-provider-versions): Versions represent different releases of a custom provider. Each version can be deployed to environments.
- [Custom Provider Deployments](https://metorial.com/api/custom-provider-deployments): Deployments track the build and deployment process of custom provid
