Skip to main content
Glama

Deploy Module

deploy_module

Deploy a new module from a GitHub repository onto the project's resource pool: a frontblok module is a Vite frontend, a logicblok module a backend built from its Dockerfile that serves port 8000 with GET /health. Its job clones the repository (the default branch head, or git_ref), builds it and serves it at the module_url the answer names; the project's CORS origins take the module in. A private repository needs the RationalBloks GitHub App installed on it. The operation is ASYNCHRONOUS: poll the returned job_id with get_job_status. While RationalBloks is being updated, the call is refused with 'RationalBloks is being updated': call it again in a few minutes.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
git_refNoBranch, tag or commit SHA for this first build (default: the default branch head)
env_varsNoEnvironment variables {NAME: value}, each value text
memory_mbNoMemory allocation (default: 128)
project_idYesProject ID (UUID) the module belongs to
module_nameYesDisplay name
module_typeYesfrontblok (a Vite frontend) or logicblok (a backend built from its Dockerfile)
cpu_millicoresNoCPU allocation (default: 100)
dockerfile_pathNoDockerfile path inside the repository (default: Dockerfile)
github_repo_urlYeshttps://github.com/<owner>/<repo>

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.4/5.0
Behavior5/5

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

Adds substantial behavior beyond annotations: async execution requiring get_job_status polling, the 'RationalBloks is being updated' refusal and retry advice, CORS origin integration, private-repo GitHub App requirement, and port 8000/GET /health for logicblok. This is rich context the annotations (non-idempotent, non-destructive) cannot convey.

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?

Dense and front-loaded, with the core deploy action and module types stated first and the async/polling caveat last. Slightly overpacked with detail (port, health endpoint) but every sentence carries operational value.

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?

No output schema exists, yet the description names the returned job_id and the follow-up tool, and covers auth requirements, retry behavior, and module-type semantics. Nothing critical for a correct invocation is missing.

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 description coverage is 100%, so the schema already documents all 9 parameters. The description clarifies module_type semantics and git_ref's default-branch behavior, but adds little beyond what the schema states; baseline 3 applies.

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?

States a specific verb+resource ('Deploy a new module from a GitHub repository onto the project's resource pool') and defines both module types, distinguishing it from redeploy_module which operates on existing modules. An agent can identify the operation without opening the schema.

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?

Implies this is for creating a new module and explicitly routes polling to get_job_status. However, it never names redeploy_module as the alternative for an existing module, so the create-vs-redeploy boundary is left to inference.

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.