Skip to main content
Glama

filament_generate_plan

Create a structured implementation plan for building Filament admin panels by defining project requirements, models, and relationships.

Instructions

Generate a Filament implementation plan

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
descriptionYesWhat you want to build
versionNo5.x
modelsNo

Implementation Reference

  • Handler for the "filament_generate_plan" tool which uses PlanGenerator or generateQuickPlan to generate a Filament implementation plan based on the provided description and model definitions.
    server.tool("filament_generate_plan", "Generate a Filament implementation plan", {
      description: descriptionSchema,
      version: versionSchema,
      models: z.array(z.object({
        name: z.string(),
        attributes: z.array(z.object({ name: z.string(), type: z.string(), required: z.boolean().optional() })).optional(),
        relationships: z.array(z.object({ type: z.string(), related: z.string() })).optional(),
      })).optional(),
    }, async ({ description, version, models }) => {
      try {
        const generator = new PlanGenerator(version);
        if (models && models.length > 0) {
          const plan = await generator.generatePlan({
            name: description,
            description,
            filamentVersion: version,
            models: models.map(m => ({
              name: m.name,
              attributes: m.attributes || [{ name: "name", type: "string", required: true }],
              relationships: m.relationships || [],
              traits: ["SoftDeletes"],
            })),
            resources: models.map(m => ({
              model: m.name,
              form: { sections: [{ title: "Details", fields: (m.attributes || []).map(a => ({ name: a.name, component: "TextInput", validation: a.required ? ["required"] : [], config: [] })) }] },
              table: { columns: (m.attributes || []).map(a => ({ name: a.name, component: "TextColumn", config: [] })) },
            })),
          });
          return { content: [{ type: "text", text: plan }] };
        }
    
        const plan = await generateQuickPlan(description, version);
        return { content: [{ type: "text", text: plan }] };
      } catch (error) {
        return {
          content: [{
            type: "text",
            text: formatErrorMessage("Plan Generation Failed", error, "Try a shorter description or provide explicit model names."),
          }],
        };
      }
    });
Behavior1/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are provided, so the description carries the full burden of behavioral disclosure. It states 'Generate' implies a write or creation operation, but doesn't specify if this is read-only, destructive, requires authentication, has rate limits, or what the output entails (e.g., a plan document, code snippets). This is inadequate for a tool with no annotation coverage.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single, efficient sentence with no wasted words. It is front-loaded and appropriately sized for the tool's name, though this conciseness comes at the cost of detail.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness1/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the complexity (3 parameters with nested objects), lack of annotations, no output schema, and low schema coverage, the description is severely incomplete. It doesn't address behavioral traits, parameter meanings beyond the schema, or what the tool returns, making it inadequate for effective agent use.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is low at 33%, with only the 'description' parameter documented. The description adds no information about parameters like 'version' or 'models', failing to compensate for the coverage gap. It doesn't explain what 'models' represent or how they influence the plan, leaving key inputs ambiguous.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose2/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description 'Generate a Filament implementation plan' restates the tool name 'filament_generate_plan' almost verbatim, making it tautological. It doesn't specify what constitutes an 'implementation plan' or what resources it generates, nor does it differentiate from siblings like filament_get_commands or filament_list_components, which might provide related functionality.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines1/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

No guidance is provided on when to use this tool versus alternatives. It doesn't mention prerequisites, context (e.g., during development setup), or exclusions, leaving the agent to guess based on the name alone among multiple sibling tools focused on documentation and components.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/serbansorin/filament-mcp-server'

If you have feedback or need assistance with the MCP directory API, please join our Discord server