Skip to main content
Glama
itunified-io

mcp-opnsense

by itunified-io

opnsense_tailscale_settings_get

Retrieve current Tailscale plugin configuration including enabled state, port, auth-key, advertised routes, accept routes, accept DNS, and exit node settings.

Instructions

Get current Tailscale plugin settings (enabled, port, auth-key, advertise-routes, accept-routes, accept-dns, exit-node).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Implementation Reference

  • Tool definition registration for opnsense_tailscale_settings_get, defining its name, description, and empty input schema.
    {
      name: "opnsense_tailscale_settings_get",
      description: "Get current Tailscale plugin settings (enabled, port, auth-key, advertise-routes, accept-routes, accept-dns, exit-node).",
      inputSchema: {
        type: "object" as const,
        properties: {},
      },
    },
  • Handler for opnsense_tailscale_settings_get: calls client GET on /tailscale/settings/get and returns the JSON response.
    case "opnsense_tailscale_settings_get": {
      const result = await client.get("/tailscale/settings/get");
      return { content: [{ type: "text", text: JSON.stringify(result, null, 2) }] };
    }
  • OPNsenseClient.get() helper method that performs the HTTP GET request used by the handler.
    async get<T>(path: string): Promise<T> {
      try {
        const response = await this.http.get<T>(path);
        return response.data;
      } catch (error: unknown) {
        throw extractError(error, `GET ${path}`);
      }
    }
  • src/index.ts:69-69 (registration)
    Registration mapping: each tailscale tool definition (including opnsense_tailscale_settings_get) is mapped to handleTailscaleTool.
    for (const def of tailscaleToolDefinitions) toolHandlers.set(def.name, handleTailscaleTool);
Behavior3/5

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

No annotations are provided, so the description must cover behavioral aspects. It correctly implies a read-only operation by using 'Get', but it does not disclose potential side effects, authentication requirements, or response format. Adding details about the output structure would enhance transparency.

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?

The description is a single, well-structured sentence that front-loads the purpose and lists relevant details. There is no redundant information, making it highly concise and 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 lack of parameters and output schema, the description is reasonably complete. It specifies the resource and the data fields retrieved. However, for a tool with no annotations, mentioning the return type (e.g., JSON object) would increase completeness.

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?

The input schema has no parameters, so the description does not need to explain parameter semantics. The schema coverage is 100%. The description still adds value by enumerating the settings returned, which aids understanding of the output.

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 clearly states the tool retrieves current Tailscale plugin settings and lists the specific settings (enabled, port, auth-key, etc.). It uses a specific verb ('Get') and resource ('Tailscale plugin settings'), which distinguishes it from sibling tools like opnsense_tailscale_settings_set and opnsense_tailscale_service_control.

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?

The description implies the tool is for reading settings, and the sibling setter tool is available for modifications, but it does not explicitly state when to use this versus alternatives. A brief note about using 'opnsense_tailscale_settings_set' for updates would improve clarity.

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