Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.bricks.tools/llms.txt

Use this file to discover all available pages before exploring further.

bricks-ctor includes a built-in MCP server that is automatically configured during bun install. The postinstall script adds a bricks-ctor entry to your .mcp.json:
{
  "mcpServers": {
    "bricks-ctor": {
      "command": "bun",
      "args": ["./node_modules/@fugood/bricks-ctor/tools/mcp-server.ts"]
    }
  }
}
This server provides project-specific tools that AI coding agents (Claude Code, Codex, CTOR, etc.) can use alongside their built-in tools.
See the CTOR MCP reference for details on how MCP servers are configured and managed.

Available tools

Run type checking and compile the project.Executes bun compile in the project directory and returns the build output.
Compile and launch a headless preview of the app, then take a screenshot.
ParameterDefaultDescription
delay3000Delay in milliseconds before taking screenshot
width600Screenshot width
height480Screenshot height
responseImagefalseReturn screenshot as base64 image content
testIdAutomation test ID to trigger
testTitleLikeFind automation test by partial title match
Search and select AI models from Hugging Face for use with BRICKS generators.huggingface_search — search models filtered by generator type.
ParameterDefaultDescription
generatorTypeGeneratorLLMGenerator type (GeneratorLLM, GeneratorVectorStore, GeneratorReranker, GeneratorGGMLTTS, GeneratorGGMLTTSVocoder, GeneratorOnnxLLM, GeneratorOnnxSTT, GeneratorTTS)
querySearch keywords
limit20Maximum results
includeFilesfalseInclude model file listings
huggingface_select — get download URLs and metadata for a specific model file. Supports GGUF and ONNX models, split files, multimodal projection files, and speaker embeddings.
Set the HF_TOKEN environment variable to access gated models on Hugging Face.
Manage media assets in your BRICKS workspace via the CLI.
  • media_boxes — list all media boxes
  • media_get_box — get details of a specific media box
  • media_files — list files in a box (filter by type, tags, with pagination)
  • media_file — get details of a specific file
  • media_upload_files — upload files to a box with optional image resizing, AI analysis, and tagging