Skip to main content
Glama

setup_playwright_tests

Generate a complete Playwright E2E test setup for documentation sites, including Docker containers and GitHub Actions CI/CD workflows.

Instructions

Generate Playwright E2E test setup for documentation site (containers + CI/CD)

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
repositoryPathYesPath to documentation repository
ssgYes
projectNameYesProject name for tests
mainBranchNomain
includeAccessibilityTestsNo
includeDockerfileNo
includeGitHubActionsNo
Behavior2/5

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

With no annotations, the description carries the full burden. It does not disclose side effects such as file creation or modifications, nor does it mention the need for authentication or permissions. The agent lacks information about what the tool actually does beyond generating files.

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 a single clear sentence without wasted words, but it could benefit from a structured format (e.g., bullet points) for readability. It is appropriately sized for a summary.

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

Completeness2/5

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

Given the tool has 7 parameters with defaults and no output schema, the description is too minimal. It does not explain what files are generated, the return value, or how to validate success. An agent would need to infer or test behavior.

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 coverage is only 29%, yet the description does not add details about parameter semantics. It hints at 'containers + CI/CD' but does not explicitly clarify that includeDockerfile and includeGitHubActions control those options. The description fails to compensate for the low schema coverage.

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

Purpose4/5

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

The description clearly states the tool's purpose: generating Playwright E2E test setup for a documentation site, mentioning containers and CI/CD. However, it does not differentiate from siblings like setup_structure or generate_config, which could overlap.

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?

No guidance is given on when to use this tool versus alternatives such as setup_structure or generate_config. There is no mention of prerequisites or scenarios where this tool is appropriate.

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/tosin2013/documcp'

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