Skip to main content
Glama

test_local_deployment

Preview documentation builds locally using a static site generator and local server to verify before deploying to GitHub Pages.

Instructions

Test documentation build and local server before deploying to GitHub Pages

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
repositoryPathYesPath to the repository
ssgYes
portNoPort for local server
timeoutNoTimeout in seconds for build process
skipBuildNoSkip build step and only start server
Behavior2/5

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

No annotations are provided, so the description must fully disclose behavior. It only says 'test' without explaining expected outcomes, side effects (e.g., file modifications, cleanup), or error handling. The tool's non-destructive nature is assumed but not confirmed.

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 concise sentence with no waste. However, it may be too brief given the tool's complexity and number of parameters, missing some necessary context.

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?

The description is insufficient for a tool with 5 parameters, no output schema, and many sibling tools. It lacks details on return values, error scenarios, and when to choose this over alternatives. More context is needed for complete understanding.

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?

Schema coverage is 80% (4 of 5 params have descriptions), meeting the high-coverage baseline. The description adds no parameter-specific information, so it neither improves nor degrades the semantic value beyond the schema.

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 tool tests documentation build and local server before deployment, with a specific verb ('Test') and resource ('documentation build and local server'). It distinguishes from siblings like deploy_site and deploy_pages by focusing on pre-deployment testing.

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 implies use before deploying to GitHub Pages but provides no explicit guidance on when to use this tool vs siblings (e.g., deploy_site, deploy_pages). No information on when not to use it or alternatives.

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