Skip to main content
Glama
TheQtCompanyRnD

squish-mcp

Official

analyze_bdd_documentation

Search and extract relevant details from local BDD-specific Squish documentation to support test script development.

Instructions

Parse the local BDD-specific Squish documentation to find relevant information.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
urlYesSource documentation URL
messageYesSummary of BDD documentation loaded
hook_patternsYesAvailable BDD hook patterns
file_structureYesExpected BDD file structure and organization
content_previewYesPreview of the documentation content
placeholder_syntaxYesSupported BDD placeholder syntax patterns
context_object_featuresYesFeatures exposed on BDD context object
implementation_examplesYesImplementation examples from docs
step_definition_patternsYesStep patterns represented as [type, pattern] pairs
Behavior2/5

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

No annotations are provided, so the description must disclose all behavioral traits. It only says 'parse...to find relevant information' without explaining the operation's nature (e.g., search vs. full dump), output format, or any side effects. This is insufficient for a tool with no annotations.

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

Conciseness4/5

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

The description is one short sentence (13 words) and is efficiently front-loaded with the verb 'Parse'. However, it could be slightly more structured or informative without losing conciseness.

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 has no parameters and an output schema exists (signalled by context), the description adequately specifies the tool's domain (BDD documentation). It could mention that it returns parsed content, but the output schema likely covers that.

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?

The input schema has zero parameters (100% description coverage by default). With 0 parameters, baseline is 4 as per guidelines. The description adds no param info, but none is needed.

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 action (Parse) and the specific resource (local BDD-specific Squish documentation). It distinguishes from sibling tools like analyze_squish_api_documentation by focusing on BDD-specific content.

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

Usage Guidelines2/5

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

The description provides no guidance on when to use this tool versus sibling tools such as analyze_squish_api_documentation or analyze_squish_rules. No when-to-use or when-not-to-use information is given.

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/TheQtCompanyRnD/squish-mcp'

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