Skip to main content
Glama
lucamarien

OPNsense MCP Server

by lucamarien

opn_list_kea_leases

List current DHCPv4 leases from the Kea DHCP server on OPNsense. Use this to view active client leases when Kea is the DHCP backend.

Instructions

List current DHCPv4 leases from the Kea DHCP server.

Use this when the OPNsense instance uses Kea for DHCP (available since 24.7). Kea is the modern replacement for ISC DHCP, recommended for HA setups. Use opn_scan_config first to check which DHCP backend is active. Returns: dict with 'rows' (list of leases) and 'rowCount' (total).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
searchNo
limitNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Behavior3/5

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

With no annotations, the description must cover behavioral traits. It mentions the return format (dict with rows/rowCount) and version requirement (24.7+). However, it omits parameter behavior, edge cases, or performance implications.

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 (4 sentences) and front-loaded with purpose. The third sentence adds background about Kea being a modern replacement, which is slightly extraneous but not harmful.

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?

For a simple list tool, it covers usage context and return format but fails to document parameters. The existence of an output schema helps, but missing parameter semantics leaves a gap in completeness.

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

Parameters1/5

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

Schema coverage is 0% and the description provides no information about the two parameters (search, limit). The agent is left without any guidance on how to use them.

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 verb 'List' and the resource 'current DHCPv4 leases from the Kea DHCP server'. It distinguishes this tool from siblings like opn_list_dhcp_leases and opn_list_dnsmasq_leases by specifying the Kea backend.

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?

It provides explicit guidance: 'Use this when the OPNsense instance uses Kea for DHCP' and suggests using opn_scan_config first to check the backend. It also mentions Kea is for HA setups, but does not explicitly exclude other backends.

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/lucamarien/opnsense-mcp-server'

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