Skip to main content
Glama

Deploy Heim Application to Cloud

deploy_heim_application_to_cloud
Idempotent

Deploy backend applications to Heim cloud using the 'heim deploy' command to make them available via console-output paths.

Instructions

Runs 'heim deploy' command to deploy an application to Heim cloud. Which will make the application availible on the path outputted in the console

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathNoAbsolute windows path to the application folder root

Implementation Reference

  • The handler function that promisifies exec and runs 'heim deploy [path] --cloud', returning stdout/stderr or error.
    async (request) => {
      const execPromise = util.promisify(exec);
      try {
        //TODO: Update to use org and project when a user has multiple orgs and projects
        const { stdout, stderr } = await execPromise(
          `heim deploy ${request.path} --cloud`
        );
        return {
          content: [
            {
              type: "text",
              text: `stdout:\n${stdout}\nstderr:\n${stderr}`,
            },
          ],
        };
      } catch (err: any) {
        return {
          content: [{ type: "text", text: `Error: ${err.message}` }],
          isError: true,
        };
      }
    }
  • Schema definition for the tool, including Zod input schema for 'path' parameter, title, description, and annotations.
    {
      title: "Deploy Heim Application to Cloud",
      description:
        "Runs 'heim deploy' command to deploy an application to Heim cloud. Which will make the application availible on the path outputted in the console",
      inputSchema: {
        path: z
          .string()
          .describe("Absolute windows path to the application folder root")
          .optional(),
      },
      annotations: {
        destructiveHint: false,
        readOnlyHint: false,
        idempotentHint: true,
        openWorldHint: true,
      },
    },
  • src/tools.ts:140-182 (registration)
    Full registration of the 'deploy_heim_application_to_cloud' tool via server.registerTool, including schema and handler.
    // TOOL: deploy_heim_application_to_cloud
    server.registerTool(
      "deploy_heim_application_to_cloud",
      {
        title: "Deploy Heim Application to Cloud",
        description:
          "Runs 'heim deploy' command to deploy an application to Heim cloud. Which will make the application availible on the path outputted in the console",
        inputSchema: {
          path: z
            .string()
            .describe("Absolute windows path to the application folder root")
            .optional(),
        },
        annotations: {
          destructiveHint: false,
          readOnlyHint: false,
          idempotentHint: true,
          openWorldHint: true,
        },
      },
      async (request) => {
        const execPromise = util.promisify(exec);
        try {
          //TODO: Update to use org and project when a user has multiple orgs and projects
          const { stdout, stderr } = await execPromise(
            `heim deploy ${request.path} --cloud`
          );
          return {
            content: [
              {
                type: "text",
                text: `stdout:\n${stdout}\nstderr:\n${stderr}`,
              },
            ],
          };
        } catch (err: any) {
          return {
            content: [{ type: "text", text: `Error: ${err.message}` }],
            isError: true,
          };
        }
      }
    );
Behavior4/5

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

Annotations indicate this is a non-read-only, non-destructive, idempotent operation with open-world semantics. The description adds valuable context by specifying it runs a command-line operation ('heim deploy') and that the deployment makes the application available on a path outputted in the console, which clarifies the execution method and output behavior beyond annotations.

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 concise with two sentences that directly state the action and outcome. It avoids unnecessary details, though the phrasing 'availible' contains a typo and could be slightly clearer (e.g., specifying 'available' and elaborating on the path output).

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

Completeness3/5

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

Given the tool's complexity (deployment operation), annotations cover safety and idempotency well, and the schema fully describes the single parameter. However, without an output schema, the description only briefly mentions a path output in the console, lacking details on return format, error handling, or deployment status, leaving gaps for agent invocation.

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?

The input schema has 100% description coverage, clearly documenting the 'path' parameter as an absolute Windows path to the application folder root. The description doesn't add any parameter-specific details beyond what the schema provides, so it meets the baseline for high schema coverage without extra value.

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 action ('deploy an application to Heim cloud') and resource ('application'), specifying it runs the 'heim deploy' command. However, it doesn't explicitly differentiate from sibling tools like 'deploy_heim_application' (which may be a local deployment variant), leaving some ambiguity.

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 provided on when to use this tool versus alternatives like 'deploy_heim_application' or 'heim_update'. The description mentions making the application available on a path, but doesn't specify prerequisites, exclusions, or comparative contexts with sibling tools.

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/Nor2-io/heim-mcp'

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