# GroundForge

> GroundForge platform, Python SDK, LangChain integration, CLI, and REST API documentation.

## Docs

- [Introduction](https://docs.groundforge.ai/index.md): Connect Agents to Channels and MCP capabilities, govern actions, and understand every request.
- [Quick Start](https://docs.groundforge.ai/quickstart.md): Choose the Weather MCP or LangChain Agent path and complete a first governed request.
- [Resource Model](https://docs.groundforge.ai/concepts/resource-model.md): See which resources belong to an Organization or Workspace and how they connect.
- [Organizations and Workspaces](https://docs.groundforge.ai/concepts/scope.md): Understand where resources and access rules are stored.
- [Agents](https://docs.groundforge.ai/concepts/agents.md): Understand managed and external Agents through the weather examples.
- [Channels](https://docs.groundforge.ai/concepts/channels.md): Understand the messaging providers available and how a Channel connects to an Agent.
- [MCP Providers](https://docs.groundforge.ai/concepts/mcp-providers.md): Understand what an MCP provider exposes and how GroundForge discovers and governs it.
- [Gateway Rules](https://docs.groundforge.ai/concepts/governance.md): Choose what happens when an Agent or MCP capability is requested.
- [Operator Review](https://docs.groundforge.ai/concepts/operator-review.md): Approve or reject a capability call before it runs.
- [Discovery](https://docs.groundforge.ai/concepts/discovery.md): Let GroundForge learn which capabilities an Agent or MCP provider exposes.
- [Observations](https://docs.groundforge.ai/concepts/observations.md): Review runtime findings that may need attention.
- [Drifts](https://docs.groundforge.ai/concepts/drifts.md): See how a discovered capability changed over time.
- [Traces](https://docs.groundforge.ai/concepts/traces-analytics.md): Follow one request from input to response.
- [Analytics](https://docs.groundforge.ai/concepts/analytics.md): Understand request patterns across a Workspace, Agent, or Channel.
- [Identity and Access](https://docs.groundforge.ai/concepts/identity.md): Understand users, groups, service accounts, roles, and assignments.
- [Examples](https://docs.groundforge.ai/examples/index.md): Learn GroundForge with the Weather MCP and LangChain weather Agent.
- [Weather MCP Example](https://docs.groundforge.ai/examples/weather-mcp.md): Discover and govern the official Python Weather MCP server.
- [Govern the Weather Capability](https://docs.groundforge.ai/guides/tool-governance.md): Test Allow, Observe, Review, and Block with the weather examples.
- [Request Review](https://docs.groundforge.ai/guides/request-review.md): Test an Operator Task from request to approval or rejection.
- [LangChain Agent Example](https://docs.groundforge.ai/examples/langchain-agent.md): Connect the GroundForge demo Agent using automatic Channel input handling.
- [LangChain Agent with Adapters](https://docs.groundforge.ai/examples/langchain-adapter.md): Convert GroundForge Channel jobs and Agent results explicitly.
- [Twilio WhatsApp](https://docs.groundforge.ai/guides/twilio-whatsapp.md): Connect Twilio WhatsApp to the LangChain weather Agent.
- [Mailgun](https://docs.groundforge.ai/guides/mailgun.md): Connect Mailgun email to the LangChain weather Agent.
- [Request Tracing](https://docs.groundforge.ai/guides/request-tracing.md): Use a Trace to diagnose one request.
- [Platform Overview](https://docs.groundforge.ai/platform/overview.md): Use the GroundForge SaaS application.
- [Dashboard](https://docs.groundforge.ai/platform/dashboard.md): Review Workspace activity, performance, and governance.
- [Agents](https://docs.groundforge.ai/platform/agents.md): Create a managed Agent or inspect an external Agent connected through the SDK.
- [External Agents](https://docs.groundforge.ai/platform/external-agents.md): Connect and inspect a LangChain or LangGraph Agent that runs in your application.
- [Channels](https://docs.groundforge.ai/platform/channels.md): Create a Channel, publish its callback, and test delivery safely.
- [MCP Providers](https://docs.groundforge.ai/platform/mcps.md): Register an MCP server, run Discovery, and review its inventory.
- [Gateways](https://docs.groundforge.ai/governance/gateways.md): Set Allow, Observe, Review, or Block for discovered capabilities.
- [Operator Tasks](https://docs.groundforge.ai/governance/approvals.md): Approve or reject capability calls that use the Review action.
- [Traces](https://docs.groundforge.ai/observability/traces.md): Follow one request from input to final delivery.
- [Analytics](https://docs.groundforge.ai/observability/analytics.md): Understand request, Agent, Channel, capability, and governance trends.
- [Organizations](https://docs.groundforge.ai/administration/organizations.md): Understand and administer the top-level GroundForge boundary.
- [Workspaces](https://docs.groundforge.ai/administration/workspaces.md): Use Workspaces to separate teams, applications, and environments.
- [Access](https://docs.groundforge.ai/administration/access.md): Manage people, non-human identities, roles, and assignments.
- [Credentials](https://docs.groundforge.ai/administration/credentials.md): Issue narrowly scoped credentials and handle secrets safely.
- [Python SDK](https://docs.groundforge.ai/sdk/overview.md): Install and configure the Python package used by the LangChain integration.
- [Configuration](https://docs.groundforge.ai/sdk/configuration.md): Reference the main arguments accepted by the LangChain SDK.
- [Connect a LangChain Agent](https://docs.groundforge.ai/sdk/langchain.md): Initialize GroundForge around a LangChain or LangGraph Agent.
- [Service Mode](https://docs.groundforge.ai/sdk/service-mode.md): Receive Channel jobs through an outbound SDK connection.
- [Inputs and Outputs](https://docs.groundforge.ai/sdk/inputs.md): Choose automatic Channel conversion or explicit adapters.
- [Governance](https://docs.groundforge.ai/sdk/governance.md): See how Gateway rules affect tools in an external Agent.
- [Media](https://docs.groundforge.ai/sdk/media.md): Process audio, images, and documents in the external Agent process.
- [Tracing](https://docs.groundforge.ai/sdk/tracing.md): Create one GroundForge Trace for each external-Agent request.
- [CLI Overview](https://docs.groundforge.ai/cli/overview.md): Manage supported GroundForge resources and workflows from a terminal.
- [Install](https://docs.groundforge.ai/cli/install.md): Install the gforge CLI package.
- [Login](https://docs.groundforge.ai/cli/login.md): Authenticate the CLI with GroundForge SaaS.
- [Context](https://docs.groundforge.ai/cli/context.md): Select the Organization, Workspace, and environment used by CLI commands.
- [Resources](https://docs.groundforge.ai/cli/resources.md): Use consistent list, describe, create, update, and delete commands.
- [Governance](https://docs.groundforge.ai/cli/governance.md): Run discovery, preview recommendations, and decide Operator Tasks.
- [Discovery and Traces](https://docs.groundforge.ai/cli/observability.md): Inspect discovery, changes, runtime mismatches, and request timelines.
- [MCP Workflows](https://docs.groundforge.ai/cli/mcp.md): Discover and govern remote or local MCP providers from the CLI.
- [Reference](https://docs.groundforge.ai/cli/reference.md): Review supported gforge command groups and common options.
- [REST API Overview](https://docs.groundforge.ai/api-reference/overview.md): Explore GroundForge endpoints with generated OpenAPI pages and an interactive request playground.
- [API Authentication](https://docs.groundforge.ai/api-reference/authentication.md): Choose user bearer authentication or a scoped service-account API key.
- [Health](https://docs.groundforge.ai/api-reference/endpoints/health.md)
- [Ready](https://docs.groundforge.ai/api-reference/endpoints/ready.md): Container-native platform readiness probe for Admin API.
- [Current User](https://docs.groundforge.ai/api-reference/endpoints/current-user.md)
- [Current User Scopes](https://docs.groundforge.ai/api-reference/endpoints/current-user-scopes.md)
- [Set Current User Active Scope](https://docs.groundforge.ai/api-reference/endpoints/set-current-user-active-scope.md)
- [Onboarding Register](https://docs.groundforge.ai/api-reference/endpoints/onboarding-register.md)
- [Onboarding Create Organization](https://docs.groundforge.ai/api-reference/endpoints/onboarding-create-organization.md)
- [Onboarding Signup](https://docs.groundforge.ai/api-reference/endpoints/onboarding-signup.md)
- [Update Current User Profile](https://docs.groundforge.ai/api-reference/endpoints/update-current-user-profile.md)
- [Unregister Current User](https://docs.groundforge.ai/api-reference/endpoints/unregister-current-user.md)
- [Validate Manifest](https://docs.groundforge.ai/api-reference/endpoints/validate-manifest.md)
- [Normalize Manifest](https://docs.groundforge.ai/api-reference/endpoints/normalize-manifest.md)
- [List Manifests](https://docs.groundforge.ai/api-reference/endpoints/list-manifests.md)
- [Apply Manifest](https://docs.groundforge.ai/api-reference/endpoints/apply-manifest.md)
- [Search Manifests](https://docs.groundforge.ai/api-reference/endpoints/search-manifests.md)
- [Get Manifest](https://docs.groundforge.ai/api-reference/endpoints/get-manifest.md)
- [Update Manifest](https://docs.groundforge.ai/api-reference/endpoints/update-manifest.md)
- [Delete Manifest](https://docs.groundforge.ai/api-reference/endpoints/delete-manifest.md)
- [Patch Manifest Status](https://docs.groundforge.ai/api-reference/endpoints/patch-manifest-status.md)
- [List Gateways](https://docs.groundforge.ai/api-reference/endpoints/list-gateways.md)
- [Apply Gateway](https://docs.groundforge.ai/api-reference/endpoints/apply-gateway.md)
- [Get Gateway](https://docs.groundforge.ai/api-reference/endpoints/get-gateway.md)
- [Update Gateway](https://docs.groundforge.ai/api-reference/endpoints/update-gateway.md)
- [Delete Gateway](https://docs.groundforge.ai/api-reference/endpoints/delete-gateway.md)
- [Create Gateway Session](https://docs.groundforge.ai/api-reference/endpoints/create-gateway-session.md)
- [List Service Accounts](https://docs.groundforge.ai/api-reference/endpoints/list-service-accounts.md)
- [Create Service Account](https://docs.groundforge.ai/api-reference/endpoints/create-service-account.md)
- [Get Service Account](https://docs.groundforge.ai/api-reference/endpoints/get-service-account.md)
- [Update Service Account](https://docs.groundforge.ai/api-reference/endpoints/update-service-account.md)
- [Delete Service Account](https://docs.groundforge.ai/api-reference/endpoints/delete-service-account.md)
- [List Credentials](https://docs.groundforge.ai/api-reference/endpoints/list-credentials.md)
- [Create Credential](https://docs.groundforge.ai/api-reference/endpoints/create-credential.md)
- [Get Credential](https://docs.groundforge.ai/api-reference/endpoints/get-credential.md)
- [Update Credential](https://docs.groundforge.ai/api-reference/endpoints/update-credential.md)
- [Delete Credential](https://docs.groundforge.ai/api-reference/endpoints/delete-credential.md)
- [List Users](https://docs.groundforge.ai/api-reference/endpoints/list-users.md)
- [Create User](https://docs.groundforge.ai/api-reference/endpoints/create-user.md)
- [Get User](https://docs.groundforge.ai/api-reference/endpoints/get-user.md)
- [Update User](https://docs.groundforge.ai/api-reference/endpoints/update-user.md)
- [Delete User](https://docs.groundforge.ai/api-reference/endpoints/delete-user.md)
- [Resend User Invitation](https://docs.groundforge.ai/api-reference/endpoints/resend-user-invitation.md)
- [Cancel User Invitation](https://docs.groundforge.ai/api-reference/endpoints/cancel-user-invitation.md)
- [List Groups](https://docs.groundforge.ai/api-reference/endpoints/list-groups.md)
- [Create Group](https://docs.groundforge.ai/api-reference/endpoints/create-group.md)
- [Get Group](https://docs.groundforge.ai/api-reference/endpoints/get-group.md)
- [Update Group](https://docs.groundforge.ai/api-reference/endpoints/update-group.md)
- [Delete Group](https://docs.groundforge.ai/api-reference/endpoints/delete-group.md)
- [List Grants](https://docs.groundforge.ai/api-reference/endpoints/list-grants.md)
- [Create Grant](https://docs.groundforge.ai/api-reference/endpoints/create-grant.md)
- [Get Grant](https://docs.groundforge.ai/api-reference/endpoints/get-grant.md)
- [Update Grant](https://docs.groundforge.ai/api-reference/endpoints/update-grant.md)
- [Delete Grant](https://docs.groundforge.ai/api-reference/endpoints/delete-grant.md)
- [Search Gateways](https://docs.groundforge.ai/api-reference/endpoints/search-gateways.md)
- [Search Users](https://docs.groundforge.ai/api-reference/endpoints/search-users.md)
- [Search Groups](https://docs.groundforge.ai/api-reference/endpoints/search-groups.md)
- [Search Service Accounts](https://docs.groundforge.ai/api-reference/endpoints/search-service-accounts.md)
- [Search Credentials](https://docs.groundforge.ai/api-reference/endpoints/search-credentials.md)
- [Search Grants](https://docs.groundforge.ai/api-reference/endpoints/search-grants.md)
- [List Roles](https://docs.groundforge.ai/api-reference/endpoints/list-roles.md)
- [Create Role](https://docs.groundforge.ai/api-reference/endpoints/create-role.md)
- [Search Roles](https://docs.groundforge.ai/api-reference/endpoints/search-roles.md)
- [Get Role](https://docs.groundforge.ai/api-reference/endpoints/get-role.md)
- [Update Role](https://docs.groundforge.ai/api-reference/endpoints/update-role.md)
- [Delete Role](https://docs.groundforge.ai/api-reference/endpoints/delete-role.md)
- [List Events](https://docs.groundforge.ai/api-reference/endpoints/list-events.md)
- [Create Event](https://docs.groundforge.ai/api-reference/endpoints/create-event.md)
- [Search Events](https://docs.groundforge.ai/api-reference/endpoints/search-events.md)
- [Get Event](https://docs.groundforge.ai/api-reference/endpoints/get-event.md)
- [Search Traces](https://docs.groundforge.ai/api-reference/endpoints/search-traces.md)
- [List Traces](https://docs.groundforge.ai/api-reference/endpoints/list-traces.md)
- [List Trace Spans Static](https://docs.groundforge.ai/api-reference/endpoints/list-trace-spans-static.md)
- [List Trace Spans](https://docs.groundforge.ai/api-reference/endpoints/list-trace-spans.md)
- [List Providers](https://docs.groundforge.ai/api-reference/endpoints/list-providers.md)
- [Create Provider](https://docs.groundforge.ai/api-reference/endpoints/create-provider.md)
- [Search Providers](https://docs.groundforge.ai/api-reference/endpoints/search-providers.md)
- [Reconcile Providers](https://docs.groundforge.ai/api-reference/endpoints/reconcile-providers.md)
- [Get Provider](https://docs.groundforge.ai/api-reference/endpoints/get-provider.md)
- [Update Provider](https://docs.groundforge.ai/api-reference/endpoints/update-provider.md)
- [Delete Provider](https://docs.groundforge.ai/api-reference/endpoints/delete-provider.md)
- [Discover Provider](https://docs.groundforge.ai/api-reference/endpoints/discover-provider.md)
- [Test Provider](https://docs.groundforge.ai/api-reference/endpoints/test-provider.md)
- [Create Provider Discovery Grant](https://docs.groundforge.ai/api-reference/endpoints/create-provider-discovery-grant.md)
- [List Provider Discoveries](https://docs.groundforge.ai/api-reference/endpoints/list-provider-discoveries.md)
- [Upload Provider Discovery](https://docs.groundforge.ai/api-reference/endpoints/upload-provider-discovery.md)
- [Preview Provider Recommendations](https://docs.groundforge.ai/api-reference/endpoints/preview-provider-recommendations.md)
- [Apply Provider Recommendations](https://docs.groundforge.ai/api-reference/endpoints/apply-provider-recommendations.md)
- [List Provider Inventory](https://docs.groundforge.ai/api-reference/endpoints/list-provider-inventory.md)
- [Search Capabilities](https://docs.groundforge.ai/api-reference/endpoints/search-capabilities.md)
- [Get Capability](https://docs.groundforge.ai/api-reference/endpoints/get-capability.md)
- [List Drifts](https://docs.groundforge.ai/api-reference/endpoints/list-drifts.md)
- [Search Drifts](https://docs.groundforge.ai/api-reference/endpoints/search-drifts.md)
- [List Operator Tasks](https://docs.groundforge.ai/api-reference/endpoints/list-operator-tasks.md)
- [Get Operator Task](https://docs.groundforge.ai/api-reference/endpoints/get-operator-task.md)
- [Decide Operator Task](https://docs.groundforge.ai/api-reference/endpoints/decide-operator-task.md)
- [List Runtime Observations](https://docs.groundforge.ai/api-reference/endpoints/list-runtime-observations.md)
- [Get Runtime Observation](https://docs.groundforge.ai/api-reference/endpoints/get-runtime-observation.md)
- [Update Runtime Observation](https://docs.groundforge.ai/api-reference/endpoints/update-runtime-observation.md)
- [Review Runtime Observation](https://docs.groundforge.ai/api-reference/endpoints/review-runtime-observation.md)
- [List Provider Runtime Observations](https://docs.groundforge.ai/api-reference/endpoints/list-provider-runtime-observations.md)
- [List Tenants](https://docs.groundforge.ai/api-reference/endpoints/tenants/list-tenants.md)
- [Create Tenant](https://docs.groundforge.ai/api-reference/endpoints/tenants/create-tenant.md)
- [Get Tenant](https://docs.groundforge.ai/api-reference/endpoints/tenants/get-tenant.md)
- [Update Tenant](https://docs.groundforge.ai/api-reference/endpoints/tenants/update-tenant.md)
- [Delete Tenant](https://docs.groundforge.ai/api-reference/endpoints/tenants/delete-tenant.md)
- [Search Tenants](https://docs.groundforge.ai/api-reference/endpoints/tenants/search-tenants.md)
- [List Sub Tenants](https://docs.groundforge.ai/api-reference/endpoints/subtenants/list-sub-tenants.md)
- [Create Sub Tenant](https://docs.groundforge.ai/api-reference/endpoints/subtenants/create-sub-tenant.md)
- [Get Sub Tenant](https://docs.groundforge.ai/api-reference/endpoints/subtenants/get-sub-tenant.md)
- [Update Sub Tenant](https://docs.groundforge.ai/api-reference/endpoints/subtenants/update-sub-tenant.md)
- [Delete Sub Tenant](https://docs.groundforge.ai/api-reference/endpoints/subtenants/delete-sub-tenant.md)
- [Search Sub Tenants](https://docs.groundforge.ai/api-reference/endpoints/subtenants/search-sub-tenants.md)
- [List Channels](https://docs.groundforge.ai/api-reference/endpoints/channels/list-channels.md)
- [Create Channel](https://docs.groundforge.ai/api-reference/endpoints/channels/create-channel.md)
- [Test Channel](https://docs.groundforge.ai/api-reference/endpoints/channels/test-channel.md)
- [Get Channel](https://docs.groundforge.ai/api-reference/endpoints/channels/get-channel.md)
- [Update Channel](https://docs.groundforge.ai/api-reference/endpoints/channels/update-channel.md)
- [Delete Channel](https://docs.groundforge.ai/api-reference/endpoints/channels/delete-channel.md)
- [Search Channels](https://docs.groundforge.ai/api-reference/endpoints/channels/search-channels.md)
- [Get Channel Analytics](https://docs.groundforge.ai/api-reference/endpoints/channels/get-channel-analytics.md)
- [Mailgun Inbound](https://docs.groundforge.ai/api-reference/endpoints/integrations/mailgun-inbound.md)
- [Twilio Whatsapp Inbound](https://docs.groundforge.ai/api-reference/endpoints/integrations/twilio-whatsapp-inbound.md)
- [Twilio Whatsapp Status](https://docs.groundforge.ai/api-reference/endpoints/integrations/twilio-whatsapp-status.md)
- [Agent Channel Callback](https://docs.groundforge.ai/api-reference/endpoints/integrations/agent-channel-callback.md)
- [Register Langchain Agent](https://docs.groundforge.ai/api-reference/endpoints/integrations/register-langchain-agent.md)
- [Discover Langchain Agent](https://docs.groundforge.ai/api-reference/endpoints/integrations/discover-langchain-agent.md)
- [Preflight Langchain Agent Tool](https://docs.groundforge.ai/api-reference/endpoints/integrations/preflight-langchain-agent-tool.md)
- [Preflight Langchain Agent](https://docs.groundforge.ai/api-reference/endpoints/integrations/preflight-langchain-agent.md)
- [Get Langchain Agent Review](https://docs.groundforge.ai/api-reference/endpoints/integrations/get-langchain-agent-review.md)
- [Record Langchain Agent Event](https://docs.groundforge.ai/api-reference/endpoints/integrations/record-langchain-agent-event.md)
- [Claim Langchain Agent Job](https://docs.groundforge.ai/api-reference/endpoints/integrations/claim-langchain-agent-job.md)
- [Start Langchain Agent Job](https://docs.groundforge.ai/api-reference/endpoints/integrations/start-langchain-agent-job.md)
- [Heartbeat Langchain Agent Job](https://docs.groundforge.ai/api-reference/endpoints/integrations/heartbeat-langchain-agent-job.md)
- [Complete Langchain Agent Job](https://docs.groundforge.ai/api-reference/endpoints/integrations/complete-langchain-agent-job.md)
- [List Agents](https://docs.groundforge.ai/api-reference/endpoints/agents/list-agents.md)
- [Create Agent](https://docs.groundforge.ai/api-reference/endpoints/agents/create-agent.md)
- [Get Agent](https://docs.groundforge.ai/api-reference/endpoints/agents/get-agent.md)
- [Update Agent](https://docs.groundforge.ai/api-reference/endpoints/agents/update-agent.md)
- [Delete Agent](https://docs.groundforge.ai/api-reference/endpoints/agents/delete-agent.md)
- [Attach Agent Channel](https://docs.groundforge.ai/api-reference/endpoints/agents/attach-agent-channel.md)
- [Detach Agent Channel](https://docs.groundforge.ai/api-reference/endpoints/agents/detach-agent-channel.md)
- [Get Agent Discovery](https://docs.groundforge.ai/api-reference/endpoints/agents/get-agent-discovery.md)
- [Request Agent Discovery](https://docs.groundforge.ai/api-reference/endpoints/agents/request-agent-discovery.md)
- [Cancel Agent Discovery](https://docs.groundforge.ai/api-reference/endpoints/agents/cancel-agent-discovery.md)
- [Get Agent Discovery Status](https://docs.groundforge.ai/api-reference/endpoints/agents/get-agent-discovery-status.md)
- [List Agent Observations](https://docs.groundforge.ai/api-reference/endpoints/agents/list-agent-observations.md)
- [List Agent Drifts](https://docs.groundforge.ai/api-reference/endpoints/agents/list-agent-drifts.md)
- [Publish Agent](https://docs.groundforge.ai/api-reference/endpoints/agents/publish-agent.md)
- [Search Agents](https://docs.groundforge.ai/api-reference/endpoints/agents/search-agents.md)
- [Get Agent Analytics](https://docs.groundforge.ai/api-reference/endpoints/agents/get-agent-analytics.md)
- [Get Workspace Runtime Analytics](https://docs.groundforge.ai/api-reference/endpoints/analytics/get-workspace-runtime-analytics.md)
- [Usage Notes](https://docs.groundforge.ai/operations/usage-notes.md): Important behaviour to know when using the SaaS platform, Channels, SDK, and MCP workflows.
- [Security](https://docs.groundforge.ai/help/security.md): Use narrow access, verified callbacks, and safe runtime data.
- [Troubleshooting](https://docs.groundforge.ai/help/troubleshooting.md): Diagnose common SaaS platform, SDK, Channel, governance, and CLI issues.
- [Supported Features](https://docs.groundforge.ai/features.md): Review the platform, SDK, and CLI capabilities covered by this guide.
- [Versions](https://docs.groundforge.ai/reference/versions.md): See the product versions used for these pages.
- [Glossary](https://docs.groundforge.ai/help/glossary.md): Review the main terms used in GroundForge.

## OpenAPI Specs

- [groundforge-openapi-v1](https://docs.groundforge.ai/openapi/groundforge-openapi-v1.json)