Appearance
Using the Docs with AI Tools
Every page on this site is published in machine-readable form, so your AI coding assistant can answer FilamentCraft questions from the real docs instead of guessing. The fastest way to get there is Context7 over MCP — set it up once and your assistant pulls the current API mid-task, in any project.
Context7 over MCP
The docs are indexed on Context7 as the library /llmstxt/filamentcraft_dev_llms_txt (360+ snippets, refreshed from llms.txt). Install the Context7 MCP server once and any assistant can pull the current API mid-task — no copy-paste, no stale training data.
The fastest path is Context7's own installer, which authenticates and wires up your client:
bash
npx ctx7 setup # then target a client: --claude, --cursor, --opencodePrefer to configure it by hand? Grab a free key at context7.com/dashboard and add the server:
bash
# Remote (recommended)
claude mcp add --scope user --transport http \
--header "CONTEXT7_API_KEY: YOUR_API_KEY" \
context7 https://mcp.context7.com/mcp
# Or run it locally over npx
claude mcp add --scope user context7 -- \
npx -y @upstash/context7-mcp --api-key YOUR_API_KEYtoml
# ~/.codex/config.toml (or .codex/config.toml in the project)
[mcp_servers.context7]
url = "https://mcp.context7.com/mcp"
http_headers = { "CONTEXT7_API_KEY" = "YOUR_API_KEY" }
# Local alternative:
# command = "npx"
# args = ["-y", "@upstash/context7-mcp", "--api-key", "YOUR_API_KEY"]json
// opencode.json
{
"mcp": {
"context7": {
"type": "remote",
"url": "https://mcp.context7.com/mcp",
"headers": { "CONTEXT7_API_KEY": "YOUR_API_KEY" },
"enabled": true
}
}
}Then just name the library in a prompt so it targets FilamentCraft (not some other package) and its live docs are pulled in:
text
Add a countdown section to my theme.
use library /llmstxt/filamentcraft_dev_llms_txtllms.txt
Two plain-text endpoints are generated on every deploy, following the llms.txt standard:
| URL | Contents |
|---|---|
https://filamentcraft.dev/llms.txt | Curated index — one line per page with a description |
https://filamentcraft.dev/llms-full.txt | The entire documentation as a single Markdown file |
Point any tool that accepts a docs URL at llms-full.txt and it gets the complete, current docs in one request.
Claude Code
Tell Claude Code where the docs live once, in your project's CLAUDE.md:
markdown
## FilamentCraft
When working with the filamentcraft/filamentcraft package, fetch
https://filamentcraft.dev/llms-full.txt for current API documentation
before writing code against it.Or ad-hoc in any session:
text
Read https://filamentcraft.dev/llms-full.txt, then add a testimonial
section to my theme.Cursor
Add the docs as an indexed source: Settings → Features → Docs → Add new doc and paste https://filamentcraft.dev/llms-full.txt. Reference it in chat with @Docs > FilamentCraft.
Any HTTP MCP server
You don't need Context7. Generic docs-fetching MCP servers (fetch, or any HTTP-capable server) work out of the box — the site is static, needs no authentication, and every page is also reachable as plain Markdown by appending .md to its clean URL:
text
https://filamentcraft.dev/guide/custom-sections.md
https://filamentcraft.dev/examples/ecommerce-store.mdVendored docs offline
The package you install also carries the source of truth locally — AI agents working inside your repository can read the API directly from vendor/filamentcraft/filamentcraft/src (fully typed, PHPStan level 6) without any network access. Pair that with php artisan filamentcraft:doctor output when asking an agent to debug an installation.
What agents should know
A few facts that keep generated code correct — worth pasting into a prompt when the agent isn't reading the docs above:
- Sections extend
BladeSection(static) orLivewireSection(interactive) and declare settings in a fluent PHP DSL — see Custom Sections. - Forms are Filament v4 Schemas —
Schema::make([...]),->live()instead of->reactive(). - Themes are one PHP class exposing Categories of settings — see Theme Authoring.
- Tenancy needs no package: sites attach to any model via a polymorphic owner — see Tenancy.
- Scaffolding:
php artisan make:filamentcraft-section,make:filamentcraft-theme,make:filamentcraft-blueprint— see Make Commands.
