Skip to main content
Glama
flisk-sh

Flisk App Builder

Official

config_explain

Read-only

Explains whether a project file is generated or user-owned, its source, current edit state, whether editing it blocks up, and what to edit instead; run before editing files you did not write.

Instructions

Explain one project file: whether Flisk generated it or the user owns it, its source, whether it is edited now, whether editing it blocks up, and what to edit instead. Run it before editing a file you did not write. Set projectPath when the MCP server is not running from the project root.

Input Schema

NameRequiredDescriptionDefault
fileYesThe file, relative to projectPath (or to the server's directory) or absolute; it must be inside the project
projectPathNoAbsolute path to the Flisk project root; run this operation from that directory.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.4.17

TDQS

A4.5/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true and openWorldHint=false, so safety is covered; the description adds that this is a pre-edit diagnostic and lists the specific facts returned. It does not describe output shape or edge cases (e.g., behavior for files outside the project), which the schema hint about 'must be inside the project' only partially covers.

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?

Three short sentences, front-loaded with the purpose, then the usage trigger, then the parameter caveat. Every sentence carries distinct information with no repetition of schema content.

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

Completeness5/5

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

With no output schema, the description takes on the burden of describing results and does so by enumerating the five questions it answers. Combined with full schema coverage and read-only annotations, an agent has everything needed to call it correctly.

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

Parameters4/5

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

Schema coverage is 100%, so baseline is 3; the description adds genuine conditional guidance for projectPath ('Set projectPath when the MCP server is not running from the project root'), which the schema does not express. It adds nothing extra for `file`, but that is already well described.

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?

States a specific verb ('Explain') and resource ('one project file') and enumerates exactly what the answer covers: ownership, source, current edit state, whether editing blocks `up`, and the recommended alternative. This is clearly distinguishable from siblings like config_verify and config_regenerate.

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?

Gives an explicit trigger: 'Run it before editing a file you did not write.' That is a concrete when-to-use condition. It does not name an alternative sibling tool or state when not to use it, so it stops short of a 5.

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