Skip to main content
Glama

suspend_site

Suspend a site on a specified server and site ID to temporarily disable access, preventing public availability without deleting data.

Instructions

Suspend a site

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
server_idYesThe ID of the server
site_idYesThe ID of the site to suspend

Implementation Reference

  • The MCP tool handler for 'suspend_site'. Calls client.suspendSite() and returns a confirmation message.
    server.tool(
      "suspend_site",
      "Suspend a site",
      {
        server_id: z.coerce.number().describe("The ID of the server"),
        site_id: z.coerce.number().describe("The ID of the site to suspend"),
      },
      async ({ server_id, site_id }) => {
        await client.suspendSite(server_id, site_id);
        return {
          content: [
            {
              type: "text" as const,
              text: `Site ${site_id} on server ${server_id} has been suspended`,
            },
          ],
        };
      }
  • Input schema for suspend_site: server_id (number) and site_id (number), both required and coerced from strings.
    {
      server_id: z.coerce.number().describe("The ID of the server"),
      site_id: z.coerce.number().describe("The ID of the site to suspend"),
  • The tool is registered via server.tool() inside the registerSiteTools() function.
    server.tool(
      "suspend_site",
      "Suspend a site",
      {
        server_id: z.coerce.number().describe("The ID of the server"),
        site_id: z.coerce.number().describe("The ID of the site to suspend"),
      },
      async ({ server_id, site_id }) => {
        await client.suspendSite(server_id, site_id);
        return {
          content: [
            {
              type: "text" as const,
              text: `Site ${site_id} on server ${server_id} has been suspended`,
            },
          ],
        };
      }
    );
  • The underlying API client method that performs POST /servers/{serverId}/sites/{siteId}/suspend to the Ploi API.
    async suspendSite(serverId: number, siteId: number): Promise<void> {
      await this.request<void>(
        "POST",
        `/servers/${serverId}/sites/${siteId}/suspend`
      );
    }
Behavior2/5

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

No annotations are provided, so the description must disclose behavioral traits. 'Suspend a site' implies a non-destructive action, but it does not explain what suspension entails, whether it is reversible, or if there are any side effects.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single sentence, which is concise, but it is under-specified. While brevity is valued, more context could be added without losing conciseness.

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?

Given the complexity of suspending a site and the presence of sibling tools like 'resume_site', the description lacks completeness. It does not mention return values, side effects, or when this operation should be used.

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 covers all parameters with descriptions (100% coverage), so the description does not need to add additional parameter details. It adds no extra meaning 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 'Suspend a site' clearly states the action (suspend) and the resource (a site). It distinguishes from sibling tools like 'resume_site' and 'deploy_site', making the purpose unambiguous.

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 provides no guidance on when to use this tool compared to alternatives such as 'resume_site' or 'deploy_site'. No prerequisites or context are given.

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/sudanese/ploi-mcp'

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