FreeCAD Docs

FreeCAD Python API documentation for AI agents and humans.

11,025 entries across 63 modules

MCP Server

# Add to Claude Code
claude mcp add freecad-docs --transport http \
  https://freecad-docs.cogram.com/mcp

Or add to ~/.claude/settings.json: 

{
  "mcpServers": {
    "freecad-docs": {
      "type": "url",
      "url": "https://freecad-docs.cogram.com/mcp"
    }
  }
}

MCP Tools

freecad_api_lookup(name) Exact lookup by qualified name. Returns full signature, docstring, and types.
freecad_docs_search(query, module?, kind?) Keyword search across all documentation. Filter by module or kind.
freecad_module_overview(module) List all classes, methods, and functions in a module.

CLI

# Install
uv tool install freecad-docs
# Look up an API by qualified name
freecad-docs lookup Part.Shape.fuse
freecad-docs lookup Arch.makeWall

# Keyword search (with optional filters)
freecad-docs search "boolean fuse cut" --module Part
freecad-docs search "wall height" --module Arch --kind property

# Browse a module's classes and functions
freecad-docs overview Part
freecad-docs overview Draft --verbose

# List all indexed modules
freecad-docs modules

CLI Commands

freecad-docs lookup <name> Look up a qualified API name. Supports partial matching and aliases.
freecad-docs search <query> Keyword search. Use --module, --kind, --limit, --full to filter.
freecad-docs overview <module> List all classes and functions in a module. Add --verbose for members.
freecad-docs modules List all 63 indexed modules with entry counts.
freecad-docs update Self-update to the latest version.

Coverage

Part TopoShape, BSplineCurve, ShapeFix, booleans, geometry kernel
BIM Wall, Structure, Window, Roof, Stairs, Site, IFC
Draft Wire, Rectangle, Circle, move, rotate, scale, arrays
Sketcher Constraints, SketchObject, parametric 2D geometry
FEM Analysis, constraints, materials, mesh, solvers
+58 CAM, TechDraw, Assembly, Mesh, PartDesign, Surface, and more

Endpoints

POST /mcp — MCP streamable HTTP
GET /health — health check (JSON)