mcp-unifi-applications

Overview Schema Source Related Servers Discussions Admin

Get Guide

get_guide

Read-onlyIdempotent

Read UniFi API prose guides on filtering syntax, error handling, getting started, and response formats, returning markdown with title and source URL. Omit the topic to list available guides.

Instructions

Read a prose guide page: filtering syntax, error handling, getting started, response formats.

Returns the page as markdown with its title and source URL. Omit the topic to list what is available. Topics resolve by slug first, then by title; when the same slug exists in several applications the reply lists them and asks for an app rather than picking one. These pages carry the conventions that endpoint schemas assume but do not repeat.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "get_guide"
  }
}

Input Schema

Name	Required	Description	Default
`app`	No	Optional app filter (network, protect, site-manager, innerspace, mobility, carrier-fabric). Omit to search all.
`topic`	No	Guide slug or search term. Omit to list all available guides.

Output Schema

Name	Required	Description	Default
`result`	Yes

Schema Changelog

Changes observed during successful MCP inspections.

Changed6 schema fields changedv0.5.0Nov 2, 2026
- removedInput schema / properties / app / anyOf
```
Removed value: -[
-  {
-    "type": "string"
-  },
-  {
-    "type": "null"
-  }
-]
```
- changedInput schema / properties / app / default
```
Previous value: -nullNew value: +""
```
- addedInput schema / properties / app / type
```
Added value: +"string"
```
- removedInput schema / properties / topic / anyOf
```
Removed value: -[
-  {
-    "type": "string"
-  },
-  {
-    "type": "null"
-  }
-]
```
- changedInput schema / properties / topic / default
```
Previous value: -nullNew value: +""
```
- addedInput schema / properties / topic / type
```
Added value: +"string"
```
First observedSep 9, 2026

TDQS

A4.7/5.0

Behavior5/5

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

Annotations already declare read-only, idempotent, non-destructive, closed-world, so the safety profile is covered; the description adds real behavioral detail beyond that: markdown return with title and source URL, empty-topic listing behavior, slug-then-title resolution order, and the notable rule that ambiguous slugs across apps produce a clarifying prompt instead of an arbitrary pick. That ambiguity handling is exactly the kind of non-obvious behavior that prevents wrong assumptions.

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?

Four sentences, each carrying distinct information: what it reads, what it returns, the empty-topic behavior, the resolution/ambiguity rule, and the positioning rationale. Front-loaded with the core action and no filler.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

With an output schema present the description needn't detail return values, yet it still notes the markdown-plus-title-plus-URL shape. Annotations cover safety, schema covers both parameters, and the description covers resolution and ambiguity behavior — nothing an agent needs to call this correctly is missing.

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%, so the baseline is 3, but the description adds resolution semantics the schema does not state: topics resolve by slug first then by title, and the app parameter becomes relevant when the same slug exists in multiple applications. That materially changes how an agent should choose between passing topic alone versus topic plus app.

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?

States a specific verb and resource ("Read a prose guide page") and enumerates the content classes it covers (filtering syntax, error handling, getting started, response formats). That enumeration plus the closing note about conventions endpoint schemas assume distinguishes it from siblings like get_response_sample, get_example, and get_docs_info without any schema inspection.

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?

Gives an explicit operating rule — omit the topic to list what is available — and implicitly positions the tool as the place to learn conventions that endpoint schemas omit. It does not name an alternative sibling or state when a different tool (e.g. get_example) would be better, so it stops short of full routing guidance.

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

Deploy Server