Skip to main content
Glama
using76
by using76

bulc_preview_fds

Read-only

Preview FDS input file content for fire simulation review before saving in BULC Building Designer.

Instructions

Generate a preview of the FDS input file without saving. Returns the complete FDS input file content for review.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
includeCommentsNoInclude explanatory comments in output. Default: true

Implementation Reference

  • Tool registration object defining name, description, input schema, and annotations for bulc_preview_fds
    {
      name: "bulc_preview_fds",
      description:
        "Generate a preview of the FDS input file without saving. " +
        "Returns the complete FDS input file content for review.",
      inputSchema: {
        type: "object" as const,
        properties: {
          includeComments: {
            type: "boolean",
            description: "Include explanatory comments in output. Default: true",
          },
        },
      },
      annotations: {
        readOnlyHint: true,
        destructiveHint: false,
      },
    },
  • Zod input validation schema for bulc_preview_fds tool
    const PreviewFdsSchema = z.object({
      includeComments: z.boolean().optional(),
    });
  • Specific handler case for bulc_preview_fds: parses input with schema and sends 'preview_fds' command to BULC client
    case "bulc_preview_fds": {
      const validated = PreviewFdsSchema.parse(args);
      result = await client.sendCommand({
        action: "preview_fds",
        params: validated,
      });
      break;
    }
  • src/index.ts:111-121 (registration)
    Top-level tool dispatch routing for FDS run tools including bulc_preview_fds to handleFdsRunTool
    // FDS Run tools (preview, validate, export, run, status, stop)
    if (
      name === "bulc_preview_fds" ||
      name === "bulc_validate_fds" ||
      name === "bulc_export_fds" ||
      name === "bulc_run_fds" ||
      name === "bulc_get_fds_status" ||
      name === "bulc_stop_fds"
    ) {
      return await handleFdsRunTool(name, safeArgs);
    }
Behavior4/5

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

Annotations indicate readOnlyHint=true and destructiveHint=false, which the description aligns with by stating 'without saving' (non-destructive) and 'for review' (read-only). The description adds valuable context beyond annotations by specifying that it returns the 'complete FDS input file content,' clarifying the output format, which is helpful since there is no output schema.

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 two concise sentences that are front-loaded with the core purpose ('Generate a preview... without saving') and follow with the output detail. Every word serves a clear purpose, with no wasted text or redundancy.

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

Completeness4/5

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

Given the tool's low complexity (1 optional parameter, no output schema), the description is nearly complete: it explains the purpose, behavior, and output. However, it could slightly improve by mentioning the parameter's effect (e.g., how comments affect the preview), but this is minor given the good annotations and schema coverage.

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

Parameters3/5

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

The input schema has 100% description coverage, with the parameter 'includeComments' fully documented in the schema. The description does not add any additional information about parameters, so it meets the baseline of 3 where the schema handles the heavy lifting.

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

Purpose5/5

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

The description clearly states the specific action ('Generate a preview') and resource ('FDS input file'), and distinguishes it from siblings by emphasizing 'without saving' (unlike bulc_export_fds or bulc_save). It explicitly mentions the output ('complete FDS input file content for review'), making the purpose distinct and well-defined.

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

Usage Guidelines4/5

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

The description provides clear context for usage ('without saving' and 'for review'), implying this tool is for inspection before committing changes. However, it does not explicitly state when not to use it or name alternatives (e.g., bulc_export_fds for saving), which prevents a perfect score.

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/using76/BULC_MCP'

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