Skip to main content
Glama
gensecaihq

pfSense MCP Server

by gensecaihq

search_logs_by_ip

Read-only

Search pfSense firewall or system logs for activity tied to a specific IP address, returning the newest matching log lines to help investigate traffic or events.

Instructions

Search logs for activity related to a specific IP address

WARNING (tracked by upstream PR #860): this endpoint may fail on firewalls with large log files due to a known pfSense REST API bug (server-side OOM at the 512 MB PHP limit). If it fails, suggest reviewing logs via SSH or the pfSense web UI instead.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
linesNoNumber of newest raw log lines to search (default 50, max 50); no match does not prove there was no older activity
log_typeNoType of logs to search (firewall, system, etc.)firewall
ip_addressYesIP address to search for

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv1.1.0
    • changedInput schema / properties / lines / description
      Previous value: -"Number of log lines to retrieve (default 50, max 50)"New value: +"Number of newest raw log lines to search (default 50, max 50);\nno match does not prove there was no older activity"
  2. First observedv1.0.0

TDQS

A3.7/5.0
Behavior5/5

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

Annotations already declare readOnlyHint=true and destructiveHint=false, and the description adds a valuable known failure mode: the endpoint may OOM on firewalls with large log files, with a concrete fallback suggestion. This is strong behavioral context beyond the structured annotations, and there is no contradiction.

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 compact and front-loaded with the core purpose, followed by a specific, necessary operational warning. Both sentences earn their place without redundancy.

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 full schema coverage, an output schema, and annotations covering the safety profile, the description plus warning is largely complete for successful invocation. It would be more complete with explicit sibling-tool differentiation, but the critical behavioral caveat is present.

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?

Schema description coverage is 100%, so the input schema already documents ip_address, lines, and log_type. The description itself does not add meaningful parameter semantics beyond restating that the search is IP-focused.

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 identifies the action and resource: 'Search logs for activity related to a specific IP address.' It distinguishes the tool's focus from generic log retrieval, though it does not explicitly contrast it with sibling log-related tools.

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 prefer this tool over alternatives like get_log_file, get_firewall_log, or search_audit_trail. The warning is about failure handling, not tool selection, so the agent is left to infer when this tool is the right choice.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

Other Tools