Retrieve the current nftables ruleset to inspect firewall configuration and verify rule definitions; note that rules alone do not prove traffic is blocked.
Read-only SysKnife action GetNftablesRuleset. read the current nftables ruleset — no params; read-only; rules do not by themselves prove that traffic is blocked
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Changes observed during successful MCP inspections.
v0.27.1Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint, idempotentHint, destructiveHint=false and openWorldHint=false, so restating 'read-only' adds nothing. The one piece of genuine added value is the warning that the ruleset does not by itself prove traffic is blocked, which guides interpretation; nothing is said about output shape or ordering, but the lower bar applies given full annotation coverage.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two short clauses, front-loaded with the action semantics, with zero wasted preamble. Minor redundancy in repeating 'read-only' twice (once in the opener, once in the list) keeps it just below top marks.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a no-param, no-output-schema read of a self-describing resource, the description covers what an agent needs plus an interpretive caveat. The only gap is that it does not explain the returned ruleset's form, which would help since no output schema exists.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The tool takes zero parameters and the description confirms 'no params', which is consistent with the schema and leaves nothing to infer. Baseline 4 for a zero-parameter tool is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
Names a specific verb and resource – 'read the current nftables ruleset' – so an agent knows exactly what it retrieves. It does not, however, distinguish itself from close siblings like sysknife_get_firewall_state, sysknife_get_firewall_backend_state, or sysknife_ufw_status, leaving ambiguity about which firewall view to call.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Usage is only implied: 'no params; read-only' tells the agent it is safe to call, and the caveat about rules not proving traffic is blocked hints at when the output is useful. There is no explicit statement of when to prefer this over the sibling firewall state tools.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.