Skip to main content
Glama

Get deploy instructions

get_deploy_instructions
Read-onlyIdempotent

Use this tool when the user wants AppDeploy to build or deploy an app. Returns workflow, coding guidance and starter files. Choose app_type (frontend-only or frontend+backend) and frontend_template (html-static, react-vite or nextjs-static); defaults are frontend+backend and react-vite. Set realtime for WebSockets/live updates; optionally provide model, intent and description. MCP version 2.12.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "get_deploy_instructions"
  }
}

Input Schema

NameRequiredDescriptionDefault
modelNoOptional model name if known, for example 'gpt-5.5'. Omit or use null when unknown.
intentNoOptional intent of this deployment. User-initiated examples: 'initial app deploy', 'bugfix - ui is too noisy'. Agent-initiated examples: 'agent fixing deployment error', 'agent retry after lint failure'. If no specific intent was given use 'app deploy'.
app_typeNoOptional app architecture. Defaults to 'frontend+backend' when omitted, including when frontend_template is provided.
realtimeNoSet true only when the app needs live cross-client updates, WebSocket subscriptions, or realtime collaborative state. Leave false or null for normal backend APIs, database, auth, AI, storage, secrets, notifications, invites, or cron.
descriptionNoOptional one-line summary of the user prompt or agent task.
mcp_versionNoSet to "2.12", the MCP version in this tool's description. Use this tool's version, not another tool's version.
frontend_templateNoOptional frontend framework. Defaults to 'react-vite' when omitted, including when app_type is provided.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedInput schema / properties / mcp_version / description
      Previous value: -"Set to \"2.11.7\", the MCP version in this tool's description. Use this tool's version, not another tool's version."New value: +"Set to \"2.12\", the MCP version in this tool's description. Use this tool's version, not another tool's version."
  2. Changed1 schema field changed
    • changedInput schema / properties / mcp_version / description
      Previous value: -"Set to \"2.11.0\", the MCP version in this tool's description. Use this tool's version, not another tool's version."New value: +"Set to \"2.11.7\", the MCP version in this tool's description. Use this tool's version, not another tool's version."
  3. Changed5 schema fields changed
    • changedInput schema / additionalProperties
      Previous value: -{}New value: +false
    • addedInput schema / properties / app_type
      Added value: +{
      +  "anyOf": [
      +    {
      +      "enum": [
      +        "frontend-only",
      +        "frontend+backend"
      +      ],
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "description": "Optional app architecture. Defaults to 'frontend+backend' when omitted, including when frontend_template is provided."
      +}
    • addedInput schema / properties / frontend_template
      Added value: +{
      +  "anyOf": [
      +    {
      +      "enum": [
      +        "html-static",
      +        "react-vite",
      +        "nextjs-static"
      +      ],
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "description": "Optional frontend framework. Defaults to 'react-vite' when omitted, including when app_type is provided."
      +}
    • addedInput schema / properties / mcp_version
      Added value: +{
      +  "description": "Set to \"2.11.0\", the MCP version in this tool's description. Use this tool's version, not another tool's version.",
      +  "maxLength": 32,
      +  "minLength": 1,
      +  "pattern": "^\\d+\\.\\d+(?:\\.\\d+)?$",
      +  "type": "string"
      +}
    • addedInput schema / properties / realtime
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "boolean"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "description": "Set true only when the app needs live cross-client updates, WebSocket subscriptions, or realtime collaborative state. Leave false or null for normal backend APIs, database, auth, AI, storage, secrets, notifications, invites, or cron."
      +}
  4. Changed4 schema fields changed
    • changedInput schema / additionalProperties
      Previous value: -falseNew value: +{}
    • addedInput schema / properties / description
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "description": "Optional one-line summary of the user prompt or agent task."
      +}
    • addedInput schema / properties / intent
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "description": "Optional intent of this deployment. User-initiated examples: 'initial app deploy', 'bugfix - ui is too noisy'. Agent-initiated examples: 'agent fixing deployment error', 'agent retry after lint failure'. If no specific intent was given use 'app deploy'."
      +}
    • addedInput schema / properties / model
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "description": "Optional model name if known, for example 'gpt-5.5'. Omit or use null when unknown."
      +}
  5. First observed

TDQS

A3.7/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint, and destructiveHint=false, so the safety profile is covered. The description adds useful context beyond that: it lists the return contents (workflow, guidance, starter files) and documents default values, which helps the agent predict behavior. It doesn't discuss auth or rate limits, but against rich annotations this is solid.

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 dense paragraph that front-loads the primary usage trigger and return value before covering parameters and version. It's efficient, though the parameter enumeration makes it slightly list-like rather than maximally tight.

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?

With no output schema, the description carries return-value burden and does so by summarizing the returned workflow, guidance, and starter files. All parameters are optional and the defaults are stated, so an agent has enough to call it correctly; only the relationship to the actual deploy tool is left implicit.

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 100%, so the schema already documents all seven parameters, establishing a baseline of 3. The description reiterates the key defaults for app_type and frontend_template and explains when to set realtime, but adds no syntax or format detail beyond what the schema provides.

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 states a specific verb and resource ('Get deploy instructions'), plus what it returns—workflow, coding guidance, and starter files. It's clear this is an instruction-fetching tool rather than the actual deploy operation, though the opening phrase 'when the user wants AppDeploy to build or deploy an app' slightly overlaps with the separate deploy_app sibling, keeping it from a 5.

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

Usage Guidelines3/5

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

It gives a clear trigger ('when the user wants AppDeploy to build or deploy an app') and explains parameter choices, but it never mentions deploy_app or any other sibling as an alternative, nor when NOT to use it. The usage context is implied rather than explicitly differentiated from the deploy action tool.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources