Documentation

Agents and MCP

Bgum’s MCP endpoint is https://api.bgum.io/mcp. It lets an agent discover Item types and fields, search accessible Items, and read their saved content.

External agent connections are not available yet. The current endpoint requires a short-lived credential issued for an active Bgum Assistant run. Developer API keys and ordinary sign-in tokens are not accepted by this endpoint.

Tool	Purpose
`list_models`	Discover available Item types and their purposes.
`describe_model`	Understand a type’s fields, options, relationships, and control contracts.
`query_records`	Find Items the authorized user can access.
`get_record`	Read an accessible Item and its versioned field values.

These tools are read-only. They do not generate, save, share, or delete Items. For a custom agent today, use the documented REST endpoints that are explicitly marked as supporting API keys. Never embed your API key in browser code or an iframe URL.