Skip to main content
Glama
itunified-io

mcp-opnsense

by itunified-io

opnsense_tailscale_service_control

Manage the Tailscale service on OPNsense: start, stop, restart, or apply configuration changes.

Instructions

Control the Tailscale service: start, stop, restart, or reconfigure (apply settings changes).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
actionYesService action to perform

Implementation Reference

  • Zod schema (TailscaleServiceActionSchema) validating the 'action' parameter for the service control tool, requiring one of: start, stop, restart, reconfigure.
    const TailscaleServiceActionSchema = z.object({
      action: z.enum(["start", "stop", "restart", "reconfigure"], {
        errorMap: () => ({ message: "action must be one of: start, stop, restart, reconfigure" }),
      }),
    });
  • Tool definition for 'opnsense_tailscale_service_control' with its name, description, and inputSchema (JSON Schema format).
    {
      name: "opnsense_tailscale_service_control",
      description:
        "Control the Tailscale service: start, stop, restart, or reconfigure (apply settings changes).",
      inputSchema: {
        type: "object" as const,
        properties: {
          action: {
            type: "string",
            enum: ["start", "stop", "restart", "reconfigure"],
            description: "Service action to perform",
          },
        },
        required: ["action"],
      },
    },
  • Handler case for 'opnsense_tailscale_service_control' — parses args with the Zod schema and POSTs to /tailscale/service/{action}.
    case "opnsense_tailscale_service_control": {
      const parsed = TailscaleServiceActionSchema.parse(args);
      const result = await client.post(`/tailscale/service/${parsed.action}`, {});
      return { content: [{ type: "text", text: JSON.stringify(result, null, 2) }] };
    }
  • src/index.ts:69-69 (registration)
    Registration of tailscale tool definitions into the toolHandlers map — maps the tool name to handleTailscaleTool handler function.
    for (const def of tailscaleToolDefinitions) toolHandlers.set(def.name, handleTailscaleTool);
  • Error handling wrapper that catches any errors and returns a formatted error message in the response.
    } catch (error) {
      const message = error instanceof Error ? error.message : String(error);
      return { content: [{ type: "text", text: `Error: ${message}` }] };
    }
Behavior3/5

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

No annotations provided, so description carries burden. It states actions but lacks details on side effects (e.g., downtime, prerequisites). Minimal but not misleading.

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?

Single sentence with no wasted words. Front-loaded purpose. Highly efficient.

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?

Given the tool's simplicity (1 param, no output schema), description covers actions well. Lacks mention of admin requirements or relation to service status tool, but adequate for the complexity.

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

Parameters4/5

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

Schema coverage is 100% with enum values. Description adds value by explaining 'reconfigure (apply settings changes)', which clarifies the action beyond the schema enum.

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?

Description clearly states the verb 'Control' and resource 'Tailscale service', listing four specific actions (start, stop, restart, reconfigure). Differentiates from sibling tools like opnsense_svc_control by specifying Tailscale.

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?

Describes actions but does not explicitly guide when to use this tool versus alternatives like opnsense_svc_control or opnsense_tailscale_service_status. No exclusion criteria or context provided.

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/itunified-io/mcp-opnsense'

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