Resources

View as Markdown

The BCTRL MCP server exposes read-only context as resources. Tools perform work; resources describe it.

ResourceDescription
docs://Shortcut to the documentation index.
docs://indexThe documentation index — every page an agent can open.
docs://platform.bctrl.ai/v1/llms.txtCanonical versioned documentation index.
docs://platform.bctrl.ai/{page}.mdOne canonical Markdown docs page.
operations://listThe generated catalog of every public API operation.
operations://{operationId}Exact metadata for one operation, including referenced schemas.
schemas://listEvery OpenAPI component schema name.
schemas://{schemaName}One request or response schema.

Any documentation URL — from bctrl_help, llms.txt, or the site — becomes a readable resource by replacing https:// with docs://, e.g. docs://platform.bctrl.ai/mcp/tools.md.

Agent pattern

Before a write operation, an agent should:

  1. Call bctrl_search_api, or call bctrl_help with query.topic and query.audience.
  2. Open the returned docs://… page (or its markdownUrl) for prose.
  3. Read operations://{operationId}, or call bctrl_get_operation, for the exact shape.
  4. Read schemas://{schemaName} for the request body.
  5. Call the generated bctrl_* tool or bctrl_call_operation once the IDs and body are clear.

This matters most for structured request bodies such as ConversationCreateRequest, ToolCreateRequest, ToolsetCreateRequest, and ProxyCreateRequest. BCTRL Tool inputs are capability-specific: inspect them with bctrl_tools_get or the built-in Tool documentation.