Skip to main content
Glama

tealflow_check_shiny_startup

Read-onlyIdempotent

Validate a Shiny app starts without errors by running the app file. Detect startup issues like missing packages, syntax errors, or timeouts to confirm correct configuration before interactive use.

Instructions

Check if a Shiny app starts without errors.

This tool runs the Shiny app file using shiny::runApp() to detect startup errors without keeping the app running or waiting for user interaction. It's useful for validating that a Teal application has been correctly configured before attempting to run it interactively.

Args: app_path (str, optional): Path to the Shiny app directory. Defaults to ".". app_filename (str, optional): Name of the app file to run (e.g., 'app.R', 'server.R'). Defaults to "app.R". timeout_seconds (int, optional): Maximum time in seconds to allow the app to start (1-120). Defaults to 15.

Returns: str: JSON object with startup validation results

Success response:
    {
        "status": "ok",
        "error_type": null,
        "message": "App started successfully",
        "logs_excerpt": "... last 20 lines of output ..."
    }

Error response:
    {
        "status": "error",
        "error_type": "missing_package" | "syntax_error" | "object_not_found" |
                      "timeout" | "file_not_found" | "rscript_not_found" |
                      "connection_error" | "execution_error",
        "message": "Detailed error description",
        "logs_excerpt": "... last 30 lines of output ..."
    }

Error Types: - missing_package: Required R package is not installed - syntax_error: R syntax error in app.R - object_not_found: Referenced R object does not exist - timeout: App did not start within the specified timeout - file_not_found: app.R file not found at specified path - rscript_not_found: Rscript command not available (R not installed) - connection_error: Network or file connection error - execution_error: Other R execution error

Examples: - Check app in current directory: (no parameters needed) - Check app in specific directory: app_path="/path/to/app" - Check specific app file: app_filename="server.R" - Use longer timeout: timeout_seconds=30

Note: This tool does not launch an interactive Shiny session. It only validates that the app can start without immediate errors. The process is terminated once startup is confirmed or an error is detected.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
app_pathNo.
app_filenameNoapp.R
timeout_secondsNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes
Behavior5/5

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

Description adds substantial behavioral context beyond annotations: it runs the app using shiny::runApp(), detects startup errors only, terminates the process after confirmation or error, and details timeout behavior. None of this contradicts the readOnlyHint and idempotentHint annotations, and it meaningfully extends them.

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 well-structured with clear sections (summary, Args, Returns, Error Types, Examples, Note) and front-loaded with the core purpose. Every section contributes valuable information—no redundant or filler content—making it appropriately detailed without being bloated.

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?

Given the tool's complexity, the description is remarkably complete. It includes parameter details, output JSON structure, a comprehensive list of error types, examples for typical use cases, and a note about non-interactive behavior. It fully equips an agent to invoke the tool correctly and interpret results, despite the presence of an output schema.

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

Parameters5/5

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

The input schema provides only type and default, with 0% description coverage. The description compensates fully by explaining each parameter's meaning (e.g., app_path 'Path to the Shiny app directory', timeout_seconds 'Maximum time in seconds' with range 1-120) and offering concrete usage examples. This goes well 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's first sentence 'Check if a Shiny app starts without errors' clearly identifies the action and resource. It further specifies the mechanism (shiny::runApp()) and differentiates from siblings by focusing on startup validation, a unique concern among the listed tealflow tools.

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 states it is 'useful for validating that a Teal application has been correctly configured before attempting to run it interactively,' providing clear context. It also notes the tool does not launch an interactive session and terminates after startup, but does not explicitly name alternative tools or exclusions, so it misses the top 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/Appsilon/TealFlowMCP'

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