UserGate MCP
Click on "Deploy Server".
Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state.
In the chat, type
@followed by the MCP server name and your instructions, e.g., "@UserGate MCPfind documentation on setting up a captive portal"
That's it! The server will respond to your query, and you can continue using it as needed.
Here is a step-by-step guide with screenshots.
UserGate MCP
UserGate MCP builds a reproducible local documentation corpus from official public UserGate documentation sources, indexes it with SQLite FTS, and exposes it to MCP clients through search, retrieval, and task-oriented operational workflow tools.
It is designed for documentation-backed administration work where responses should be grounded in a local, auditable corpus instead of live web lookup at query time.
This project is an independent documentation tooling project and is not affiliated with or endorsed by UserGate.
What It Provides
Offline-first ingestion from official public UserGate documentation surfaces.
Coverage audit before indexing, so missing or failed upstream files are visible.
Local SQLite FTS index over normalized HTML and PDF text chunks.
Content-hash deduplication with alternate source URL preservation.
Product, version, language, and document-type metadata for targeted retrieval.
MCP tools for status, facets, document search, exact document fetch, and section-level retrieval.
MCP resources and prompts for guided documentation usage and quick corpus orientation.
Admin-oriented workflow packs for upgrade planning, VPN, authentication, routing, web policy, captive portal, HA, certificates, SIEM, Management Center, and Log Analyzer operations.
Retrieval regression evaluation for ranking and source-selection changes.
Workflow-pack regression evaluation for operational checklist and source quality.
Query expansion for common English/Russian administration terminology gaps.
Human inspection commands for exploring the generated SQLite index without an MCP client.
Repository hygiene that keeps downloaded manuals, raw pages, reports, and the SQLite index out of Git.
Related MCP server: doc-lib-mcp
Corpus Baseline
The generated corpus is intentionally not committed. A current local sync builds an index with this approximate shape:
Metric | Value |
Public documentation URLs discovered |
|
Indexed documents |
|
Indexed chunks |
|
UserGate documentation changes over time. Run the sync pipeline before relying on corpus statistics in a new environment.
Architecture
src/usergate_mcp/
discovery.py Discover sitemap, crawl-discovered links, and PDF catalog entries
download.py Store raw official documentation files locally
audit.py Verify manifest coverage and report upstream failures
extract.py Normalize HTML and PDF text
metadata.py Infer product, version, language, and document type
index.py Build and query the SQLite FTS index
cli.py Expose status, search, document, section, catalog, and workflow commands
evaluation.py Run retrieval regression checks against golden queries
inspect.py Print human-readable index inventory as JSON
workflows.py Assemble operational source packs and checklists
server.py Expose the local corpus through MCP tools
update.py Bootstrap or incrementally refresh the generated corpus
sync.py Run discovery, download, audit, and indexing in order
data/
raw/ Generated downloaded corpus, ignored by Git
reports/ Generated audit and download reports, ignored by Git
index/ Generated SQLite index, ignored by Git
manifests/ Generated discovery manifests, ignored by GitQuick Start
python -m venv .venv
.\.venv\Scripts\python -m pip install -e .[dev]
.\.venv\Scripts\python -m usergate_mcp.update
.\.venv\Scripts\python -m usergate_mcp.serverusergate_mcp.update is the recommended corpus command. On a fresh checkout it downloads public documentation files into a local generated corpus and builds the index. On an existing checkout it compares the newly discovered source set with the previous local state, downloads new or changed files, refreshes reports, and rebuilds the index.
Individual pipeline stages can also be run directly:
.\.venv\Scripts\python -m usergate_mcp.discovery
.\.venv\Scripts\python -m usergate_mcp.download
.\.venv\Scripts\python -m usergate_mcp.audit
.\.venv\Scripts\python -m usergate_mcp.indexUseful update modes:
.\.venv\Scripts\python -m usergate_mcp.update --check-only
.\.venv\Scripts\python -m usergate_mcp.update --force-redownload
.\.venv\Scripts\python -m usergate_mcp.update --skip-indexCommon CLI commands:
.\.venv\Scripts\python -m usergate_mcp.cli status
.\.venv\Scripts\python -m usergate_mcp.cli search "ipsec vpn tunnel" --product NGFW
.\.venv\Scripts\python -m usergate_mcp.cli sections "ssl inspection certificate" --product NGFW
.\.venv\Scripts\python -m usergate_mcp.cli workflow vpn --scenario "ipsec tunnel" --version 7.xInstalled script aliases include usergate-status, usergate-search, usergate-sections, usergate-doc, usergate-section, usergate-catalog, and usergate-workflow.
MCP Setup
See docs/codex-mcp-setup.md for a Codex stdio MCP configuration example and smoke-check commands. See docs/mcp-client-setup.md for Codex, Claude Code, Claude Desktop, Cursor, and VS Code configuration snippets.
The server is intended to run from a local checkout with a generated corpus and index. The repository does not ship the downloaded documentation corpus.
MCP Tool Surface
Core retrieval tools:
get_project_status()list_index_facets()search_docs(query, product?, version?, language?, doc_type?, limit?)get_document(doc_id_or_url, max_chars?)search_doc_sections(query, product?, version?, language?, doc_type?, limit?)get_doc_section(chunk_id, context_chunks?)list_documents_catalog(product?, doc_type?, language?, limit?)
Operational workflow tools:
prepare_upgrade_plan(product, target_version, current_version?, language?)prepare_vpn_debug_pack(scenario, version?, language?)prepare_auth_debug_pack(auth_type, version?, language?)prepare_change_research(task, product?, version?, language?)prepare_routing_debug_pack(scenario, version?, language?)prepare_web_policy_pack(scenario, version?, language?)prepare_captive_portal_pack(scenario, version?, language?)prepare_backup_ha_pack(product, scenario, version?, language?)prepare_cert_lifecycle_pack(scenario, version?, language?)prepare_ops_platform_pack(product, scenario, version?, language?)
Workflow tools return the queries used, a focused checklist, and deduplicated local documentation sources with snippets, headings, locators, chunk IDs, and document IDs.
MCP resources expose compact orientation data:
usergate://statususergate://facetsusergate://productsusergate://manualsusergate://reports/updateusergate://reports/auditusergate://reports/indexusergate://documents/{doc_id}
Prompt templates include guide_usergate_docs_usage, admin_lookup, change_plan, upgrade_prompt, vpn_debug_prompt, routing_debug_prompt, web_policy_prompt, certificate_prompt, and ops_platform_prompt.
Retrieval Behavior
Search ranking is tuned for administration use cases:
articles, manuals, and hardware documents are preferred by default over less relevant glossary or release-note results;
query intent can boost release notes, glossary entries, or manuals when the wording asks for them;
query expansion bridges common English/Russian terminology gaps such as
collector,certificate,routing,backup,restore, andtroubleshooting;results are diversified by document so one long manual does not dominate the result set;
section-aware retrieval can cite narrow chunks and manual pages instead of only full-document matches;
product-aware scoring reduces cross-product noise for Management Center, SIEM, and Log Analyzer workflows.
Development
Install development dependencies and run the test suite:
.\.venv\Scripts\python -m pip install -e .[dev]
.\.venv\Scripts\python -m pytest -qSome workflow tests expect a built local index at data/index/usergate_docs.sqlite3. Run python -m usergate_mcp.sync first in a fresh checkout.
Index-dependent tests are marked as integration and are skipped when the local SQLite index is absent. To run only those checks after building the corpus:
.\.venv\Scripts\python -m pytest -q -m integrationRun retrieval regression checks:
.\.venv\Scripts\python -m usergate_mcp.evaluationThe default suite contains 15 golden admin scenarios across NGFW, SWG, SIEM, Management Center, Log Analyzer, WAF, and UserGate Client. See docs/retrieval-evaluation.md for case format and query-expansion guidance.
Run workflow-pack regression checks:
.\.venv\Scripts\python -m usergate_mcp.workflow_evaluationThe workflow suite checks task-oriented packs for checklist presence, source counts, product-appropriate sources, and deduplication. See docs/workflow-evaluation.md.
Inspect the generated SQLite index without an MCP client:
.\.venv\Scripts\python -m usergate_mcp.inspectSee docs/human-inspection.md for SQLite and Datasette inspection examples.
Repository Hygiene
Generated files are excluded from Git:
data/raw/data/reports/data/index/data/manifests/*.json.venv/Python cache and test cache directories
Only source code, tests, documentation, and placeholder .gitkeep files are intended to be committed.
Contributing
See CONTRIBUTING.md for development setup, test guidance, and repository hygiene rules.
Security
See SECURITY.md for vulnerability reporting guidance and security scope.
License
The project code is released under the MIT License. See NOTICE for trademark, affiliation, and generated-corpus notes.
Source Scope
The current public source of truth is https://docs.usergate.com/ because it provides:
an official sitemap;
a public PDF documentation catalog;
canonical documentation pages that observed public support URLs redirect or mirror into.
Official linked attachments from support.usergate.com and static.usergate.com are retained when referenced by in-scope documentation pages.
Limitations
The project indexes public documentation only.
Authenticated customer materials and private support artifacts are out of scope.
Image-only PDF content is skipped unless an OCR path is added later.
Sync results depend on availability and structure of the upstream public documentation site.
Available Tools
18 toolsget_docA
Fetch a local document by canonical doc_id or any known source URL.
| Name | Required | Description | Default |
|---|---|---|---|
| max_chars | No | ||
| reference | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations provided, so description carries full burden. It implies a read-only fetch operation, which is adequate, but does not disclose error handling, return format, or prerequisites, leaving gaps in understanding behavior.
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?
Single sentence, no filler, efficiently conveys the core function.
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?
Given no output schema and no annotations, the description is minimally complete for a simple fetch tool but lacks details on return value and behavior, especially with many siblings where context could help disambiguation.
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?
Schema coverage is 0%, but the description adds meaning for 'reference' (doc_id or URL), compensating partially. However, 'max_chars' is left unexplained, so the agent must infer its purpose from name and default value.
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?
The description clearly states the verb 'fetch' and resource 'local document', specifying the identifiers 'canonical doc_id' or 'known source URL', which is specific and distinguishes from sibling like get_doc_section.
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?
No guidance on when to use this tool versus alternatives like search_docs or get_doc_section. The agent must infer applicability from the identifier description.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_doc_sectionC
Fetch a local indexed section/chunk by chunk_id.
| Name | Required | Description | Default |
|---|---|---|---|
| chunk_id | Yes | ||
| max_chars | No |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description carries full burden. It does not disclose behavior such as authentication requirements, side effects (none expected), error handling, or return value structure. The agent has no idea what happens on failure or how output is formatted.
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?
The description is a single sentence with no wasted words. However, it is slightly under-specified for the information needed, but conciseness itself is good.
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?
Given the tool has two parameters and no output schema or annotations, the description should provide more context about what output to expect, how to use 'max_chars', and how 'chunk_id' relates to the indexed sections. Currently, it lacks completeness for an agent to use effectively.
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?
Schema description coverage is 0%, and the description adds no meaning to the parameters. 'chunk_id' is not explained (type, format, example), and 'max_chars' is left ambiguous (likely character limit on content). The default of 4000 is given in schema but no interpretation.
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?
The description clearly states the action ('Fetch') and the resource ('local indexed section/chunk') using the identifier 'chunk_id'. It distinguishes from sibling tools like 'search_doc_sections' and 'get_doc' by specifying 'local indexed section/chunk'.
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?
The description provides no guidance on when to use this tool versus alternatives like 'search_doc_sections' or 'get_doc'. No context about prerequisites, limitations, or typical use cases is given.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_project_statusA
Return current discovery, download, and audit summary.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description must carry the behavioral disclosure burden. It only states that it returns a summary, but does not indicate whether the operation is read-only, safe, or has side effects. With no output schema, the agent does not know the structure of the returned data.
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?
The description is a single sentence that efficiently conveys the purpose without any unnecessary words. It is front-loaded and earns its place.
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 tool with no output schema, the description should provide more detail about what the summary contains. Without it, the agent lacks context on the return structure, making the description incomplete despite its simplicity.
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?
There are no parameters, so schema coverage is complete (100%). The description adds no parameter information, which is acceptable given zero parameters. According to calibration, 0 params baseline is 4.
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?
The description clearly states the tool returns a 'current discovery, download, and audit summary,' which is a specific verb and resource. It distinguishes from sibling tools like 'get_doc' and 'list_documents_catalog' which focus on documents or other entities.
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?
The description does not provide explicit guidance on when to use this tool versus alternatives. It implies usage for retrieving the three statuses but offers no exclusions or context about when to use other tools.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
list_documents_catalogC
List indexed documents with optional product, type, and language filters.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | ||
| product | No | ||
| doc_type | No | ||
| language | No |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description carries full burden. It does not disclose behavioral traits like read-only nature, pagination, result limits, or performance implications. The only behavioral hint is 'list' implying retrieval, but no further detail.
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?
The description is a single sentence of 11 words, making it very concise. However, this brevity sacrifices completeness, as it omits the limit parameter and other behavioral context.
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?
Given the tool has 4 parameters, no output schema, and no annotations, the description is insufficient. It does not explain default behavior when no filters are applied, pagination, ordering, or response structure. Agents need more context for effective usage.
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?
Schema description coverage is 0%. The description adds meaning for three parameters (product, type, language) but omits the 'limit' parameter entirely. No enums or constraints are explained, so the description only partially compensates for the missing schema descriptions.
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?
The description clearly states the tool lists indexed documents and mentions three optional filters (product, type, language). It is specific but does not explicitly differentiate from sibling tools like list_index_facets or list_pdf_catalog.
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?
The description only says filters are optional but provides no guidance on when to use this tool versus alternatives such as search_docs or get_doc. There is no mention of prerequisites, context, or exclusions.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
list_index_facetsA
List available products, versions, languages, and document types from the local index.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description carries full burden. It describes a read-only operation but does not mention authentication, performance, or behavior with empty index. Adequate but lacks depth.
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?
Single sentence, directly states purpose with no wasted words. Front-loaded and efficient.
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 simple tool with no parameters and no output schema, the description covers the essential purpose. Could mention return format, but not necessary for this level of simplicity.
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?
No parameters exist; schema coverage is 100%. Description adds no param info but that's fine for a parameterless tool. Baseline of 4 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?
The description clearly states the tool lists available facets (products, versions, languages, document types) from the local index. It uses a specific verb and resource, and distinguishes from siblings like list_documents_catalog which list different things.
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?
No guidance on when to use this tool versus alternatives such as search_docs or get_doc. The description does not mention context or exclusions.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
list_pdf_catalogB
Return PDF manuals discovered from the official UserGate PDF catalog.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description bears full responsibility for behavioral disclosure. It does not mention whether the operation is read-only, cached, or requires authentication, nor does it specify the output format or any side effects.
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?
The description is a single, front-loaded sentence with no unnecessary words. It is efficient but could be slightly more structured, e.g., mentioning that it returns a list.
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?
As a tool with no parameters, the description is mostly adequate but lacks details about the return format (e.g., list of strings or objects). With no output schema, the description could provide more context on what 'PDF manuals' entails.
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 has zero parameters and 100% schema coverage, so the baseline is 4. The description does not need to elaborate on parameters, as none exist.
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?
The description clearly states the action ('Return'), the resource ('PDF manuals'), and the source ('official UserGate PDF catalog'), making the tool's purpose unambiguous and distinct from siblings like list_documents_catalog.
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?
The description provides no guidance on when to use this tool versus alternatives such as 'list_documents_catalog' or 'search_docs'. No context is given about prerequisites or typical use cases.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
prepare_auth_debug_packC
Build a documentation-backed checklist and source pack for authentication debugging.
| Name | Required | Description | Default |
|---|---|---|---|
| version | No | ||
| language | No | ||
| auth_type | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations provided; the description only says 'build' without disclosing whether the tool is read-only, destructive, or requires special permissions. Missing details like output format or side effects.
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?
Single sentence, no waste. Could add structure (e.g., list parameters) but remains appropriately sized.
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?
No output schema, no annotations, and incomplete parameter guidance. For a complex domain like authentication debugging, the description is far from sufficient.
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?
Schema description coverage is 0%, and the description fails to explain any of the three parameters (auth_type, version, language). The agent gets no guidance on how to fill them.
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?
The description clearly states the tool builds a checklist and source pack for authentication debugging, specifying the verb and resource. However, it does not differentiate from sibling tools like prepare_routing_debug_pack or prepare_vpn_debug_pack.
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?
No guidelines on when to use this tool versus alternatives. The description lacks any context about prerequisites or scenarios.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
prepare_backup_ha_packC
Build a documentation-backed checklist and source pack for backup, restore, HA, or recovery work.
| Name | Required | Description | Default |
|---|---|---|---|
| product | Yes | ||
| version | No | ||
| language | No | ||
| scenario | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description bears full responsibility. It indicates the tool generates a pack (likely read-only), but does not confirm whether it causes side effects, requires authentication, or modifies system state. The behavioral impact is ambiguous.
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?
The description is a single, front-loaded sentence that efficiently conveys the core purpose. While concise, it is not overly terse; it includes key details about the output (checklist and source pack) and scope.
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?
Given the tool's moderate complexity (4 parameters, no output schema, no annotations), the description is insufficient. It fails to explain the pack's contents, expected output, or how parameters affect behavior, leaving significant gaps for the agent.
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?
With 0% schema description coverage and no parameter mentions in the description, the agent receives no insight into the purpose or format of the four parameters (product, version, language, scenario). The description adds no meaning beyond the parameter names.
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?
The description clearly states the tool's function: building a documentation-backed checklist and source pack for backup, restore, HA, or recovery work. It specifies the resource (pack) and action (prepare), and distinguishes from sibling tools that focus on other scenarios (e.g., auth debug, captive portal).
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?
The description implies usage for backup/HA scenarios but provides no explicit guidance on when to use this tool versus similar 'prepare_*_pack' siblings. It does not mention prerequisites, conditions, or alternatives, leaving the agent to infer context.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
prepare_captive_portal_packC
Build a documentation-backed checklist and source pack for captive portal planning or troubleshooting.
| Name | Required | Description | Default |
|---|---|---|---|
| version | No | ||
| language | No | ||
| scenario | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, and the description fails to disclose behavioral traits such as side effects, required permissions, or whether the operation is read-only or modifies state. It only states what it produces, not how it behaves.
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?
The description is a single concise sentence that front-loads the action and resource. However, it is too brief to cover all necessary information, but it avoids unnecessary verbosity.
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?
Given the lack of annotations and output schema, and three parameters with no descriptions, the description is incomplete. It does not explain prerequisites, output format, or how to use the pack effectively.
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 input schema has three parameters with no descriptions (0% coverage), and the tool description adds no meaning or context about their purpose, format, or acceptable values. The description does not mention any parameter.
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?
The description uses a specific verb 'Build' and identifies a clear resource: 'documentation-backed checklist and source pack for captive portal planning or troubleshooting'. It distinguishes from sibling tools (e.g., prepare_auth_debug_pack) by specifying the topic.
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?
The description does not provide when to use this tool over alternatives, nor does it mention any exclusions or prerequisites. It implies use for captive portal scenarios but lacks explicit guidance.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
prepare_cert_lifecycle_packC
Build a documentation-backed checklist and source pack for certificate lifecycle work.
| Name | Required | Description | Default |
|---|---|---|---|
| version | No | ||
| language | No | ||
| scenario | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description carries the full burden. It mentions 'documentation-backed checklist and source pack' but does not disclose behavioral traits such as whether the tool modifies any state, requires specific permissions, or has side effects. The agent cannot infer safety or side effects.
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?
Single sentence with no wasted words. However, the extreme brevity leaves many gaps; it's concise but under-specified. Still, it is well structured as a one-line purpose statement.
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?
Given the lack of output schema, no annotations, and three undocumented parameters, the description is incomplete. It does not explain what a 'source pack' is, what 'certificate lifecycle' entails, how parameters affect the output, or what the tool returns. The agent would be unable to use this tool confidently based solely on the description.
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?
Schema description coverage is 0%, meaning the description adds no information about the three parameters (version, language, scenario). The description does not explain their purpose, constraints, or relationship to the tool's function. Parameters are completely undocumented beyond the schema.
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?
The description clearly states the verb 'Build' and the resource 'documentation-backed checklist and source pack for certificate lifecycle work.' It distinguishes this tool from siblings like prepare_auth_debug_pack or prepare_vpn_debug_pack by specifying the domain (certificate lifecycle).
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?
No explicit guidance on when to use this tool versus alternatives (e.g., other prepare_* packs). The description implies usage for certificate lifecycle work but does not provide exclusion criteria or mention when to choose another tool.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
prepare_change_researchC
Build a documentation-backed research pack for a planned configuration or troubleshooting task.
| Name | Required | Description | Default |
|---|---|---|---|
| task | Yes | ||
| product | No | ||
| version | No | ||
| language | No |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description must disclose all behaviors. It only mentions 'documentation-backed research pack' without detailing what the tool does internally, side effects, or output format. It does not state that it is read-only or destructive.
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?
The description is a single sentence, which is concise, but could benefit from additional structure or detail. It lacks front-loading of key information like output type or required inputs.
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?
Given 4 parameters and no output schema or annotations, the description is incomplete. It does not specify what the research pack contains, how it is accessed, or any dependencies. The tool's complexity warrants a more comprehensive description.
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?
Schema description coverage is 0%, so the description must explain parameters. Only 'task' is hinted by the phrase 'planned configuration or troubleshooting task', but product, version, and language are not mentioned. Their meaning and impact remain unclear.
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?
The description clearly states the action (Build) and the resource (research pack) and provides context (for planned configuration or troubleshooting). However, it does not explicitly differentiate from sibling tools like prepare_auth_debug_pack or prepare_upgrade_plan.
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?
The description implies usage for change planning or troubleshooting but lacks explicit guidance on when to use this tool versus alternatives, or any exclusions. No when-not or alternative tool names are provided.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
prepare_ops_platform_packB
Build a documentation-backed checklist and source pack for Management Center, SIEM, or Log Analyzer operations.
| Name | Required | Description | Default |
|---|---|---|---|
| product | Yes | ||
| version | No | ||
| language | No | ||
| scenario | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Without annotations, the description carries the burden of disclosing behavior. It mentions 'documentation-backed checklist and source pack' but does not clarify the process, side effects, or required permissions, leaving significant ambiguity.
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?
The description is a single, front-loaded sentence that is concise. However, it is too sparse and could include more useful information without sacrificing brevity.
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?
Given the tool has 4 unspecified parameters, no output schema, no annotations, and is part of a family of similar prepare packs, the description is incomplete. It fails to explain what the pack contains, what a 'scenario' means, or how parameters affect output, leaving the agent underinformed.
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 description provides no explanation for the four parameters (product, version, language, scenario). With schema description coverage at 0%, the agent has no guidance on allowed values or format, making parameter usage entirely guesswork.
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?
The description clearly states the tool builds a documentation-backed checklist and source pack for three specific products (Management Center, SIEM, Log Analyzer), which distinguishes it from sibling tools focused on other products or tasks.
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?
The description implies usage for operations on the mentioned products but does not explicitly state when to use this tool versus alternatives like get_doc or other prepare packs, leaving usage guidance vague.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
prepare_routing_debug_packC
Build a documentation-backed checklist and source pack for routing troubleshooting.
| Name | Required | Description | Default |
|---|---|---|---|
| version | No | ||
| language | No | ||
| scenario | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description must fully disclose behavioral traits. It only states the output is a checklist and pack but omits side effects, authentication needs, rate limits, or whether it is read-only. For a debug pack tool, this is insufficient.
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?
The description is a single concise sentence, but it sacrifices necessary detail. It front-loads the purpose but fails to elaborate on parameters or output. Given the tool's complexity, it is too short.
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?
The tool has 3 parameters (1 required) and no output schema. The description does not explain the required 'scenario' field, optional 'version' and 'language', or what the checklist/pack looks like. This is critically incomplete for an agent to use correctly.
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?
Schema description coverage is 0%, meaning the schema provides no parameter descriptions. The description does not mention any parameters, leaving 'scenario', 'version', and 'language' completely unexplained. The agent cannot determine valid inputs.
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?
The description clearly states the tool builds a 'documentation-backed checklist and source pack' for 'routing troubleshooting', which is specific and distinguishes it from siblings like prepare_vpn_debug_pack. However, it could be more precise about what a 'source pack' contains.
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?
No guidance is provided on when to use this tool versus alternatives such as other debug packs (e.g., prepare_vpn_debug_pack). The description does not mention use cases, prerequisites, or exclusions.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
prepare_upgrade_planC
Build a documentation-backed upgrade planning pack for a UserGate product.
| Name | Required | Description | Default |
|---|---|---|---|
| product | Yes | ||
| language | No | ||
| target_version | Yes | ||
| current_version | No |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description carries full burden but says nothing about side effects, authentication needs, or what 'build' entails. It does not reveal behavioral traits such as whether it modifies data or requires network access.
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?
The description is a single vague sentence; while concise, it sacrifices necessary detail and does not front-load critical information.
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?
Given 4 parameters, no output schema, no annotations, and many siblings, the description is grossly insufficient—it leaves the agent guessing about inputs, outputs, and purpose.
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?
Schema description coverage is 0% and the description adds no parameter details. The agent cannot infer valid values for product, target_version, language, or current_version from the text.
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?
The description clearly states the tool builds an upgrade planning pack for UserGate products, but fails to differentiate from sibling 'prepare_*' tools like prepare_change_research or prepare_vpn_debug_pack.
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?
No guidance on when to use this tool versus alternatives; the description gives no context about prerequisites, typical use cases, or exclusions.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
prepare_vpn_debug_packC
Build a documentation-backed checklist and source pack for VPN troubleshooting.
| Name | Required | Description | Default |
|---|---|---|---|
| version | No | ||
| language | No | ||
| scenario | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations provided; description does not disclose key behaviors (e.g., read-only vs destructive, required permissions, output format). Only states it 'builds' a pack without details.
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?
Single sentence with clear purpose but lacks necessary detail. Conciseness is achieved by omitting critical information.
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?
Description fails to explain key aspects: parameter meanings, output, return values, or when to use among many sibling pack tools. Incomplete for a tool with 3 parameters and no output schema.
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?
Schema has three parameters with 0% description coverage; description does not mention any parameter names, purposes, or constraints. No value added beyond the bare schema.
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?
Description clearly states the tool builds a 'documentation-backed checklist and source pack for VPN troubleshooting', specifying the resource (VPN) and action (build pack). Differentiates from siblings by mentioning VPN, though similar pack tools exist.
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?
No guidance on when to use this tool versus other debug pack tools (e.g., prepare_auth_debug_pack). No context on prerequisites or ideal scenarios.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
prepare_web_policy_packC
Build a documentation-backed checklist and source pack for web filtering or SSL inspection work.
| Name | Required | Description | Default |
|---|---|---|---|
| version | No | ||
| language | No | ||
| scenario | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations provided, the description carries the full burden. It only states that the tool 'builds' a pack, implying a constructive action, but does not disclose any behavioral traits such as permissions needed, side effects, or output format. The agent has no insight into what happens during execution.
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?
The description is a single concise sentence, but it omits necessary details. While it is not verbose, the lack of structure and missing information makes it less effective. It earns a 4 for being compact and front-loaded, but loses a point for under-specification.
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?
Given the tool has 3 parameters (1 required) and no output schema, the description should provide enough context for proper invocation. However, it fails to explain the parameters or the output. The agent is left guessing about the 'scenario' input and what the generated pack contains.
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 schema has 0% description coverage, and the description adds no information about the three parameters (version, language, scenario). The agent cannot determine what values to provide for the required 'scenario' parameter or the optional ones. The description fails to compensate for the lack of schema documentation.
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?
The description clearly states the tool builds a documentation-backed checklist and source pack for web filtering or SSL inspection. It specifies the verb 'Build' and the resource 'web policy pack', distinguishing it from sibling tools like prepare_auth_debug_pack which target different domains.
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?
The description does not provide any guidance on when to use this tool versus alternatives. It lacks information about prerequisites, context, or when not to use it. No comparison with other prepare_* tools is given.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
search_docsC
Search the local UserGate documentation index.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | ||
| query | Yes | ||
| product | No | ||
| version | No | ||
| doc_type | No | ||
| language | No |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description carries full burden. It does not disclose search behavior (e.g., full-text, fuzzy, case sensitivity), return format, or any side effects. This is insufficient for safe agent use.
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?
The description is a single concise sentence, which is efficient. However, it is overly terse given the tool's complexity, leaving out essential information. It earns its place for brevity but sacrifices clarity.
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?
With 6 parameters, no output schema, and no annotations, the minimal description is severely incomplete. It fails to convey return values, behavior, or parameter details, leaving the agent unprepared to use the tool effectively.
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 input schema has 6 parameters with 0% description coverage, yet the description does not explain any of them (e.g., query, limit, product). The agent has no information on how to use these parameters effectively.
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?
The description states the verb 'Search' and the resource 'local UserGate documentation index', clearly indicating the tool's purpose. However, it does not differentiate from sibling tools like 'search_doc_sections', which also perform searches, leading to possible confusion.
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?
The description provides no guidance on when to use this tool versus alternatives such as 'get_doc', 'get_doc_section', or 'search_doc_sections'. An agent would lack context for appropriate selection.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
search_doc_sectionsC
Search the local UserGate index at section/chunk granularity.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | ||
| query | Yes | ||
| product | No | ||
| version | No | ||
| doc_type | No | ||
| language | No |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description carries the full burden. It only states it searches, but does not disclose whether it is read-only, whether results are ranked, if it has rate limits, or what happens on empty queries. Minimal behavioral context.
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?
The single sentence is concise but under-specifies. It lacks structure or front-loading of key information. Being short does not equate to conciseness when critical details are missing.
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 tool with 6 parameters, no output schema, and no annotations, the description is severely incomplete. It does not explain the local index context, how search results are structured, or what the parameters (product, version, etc.) filter. Substantial gaps remain.
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?
Schema description coverage is 0%. The description adds no meaning beyond the parameter names. For 5 optional parameters (limit, product, version, doc_type, language) with no defaults explained, and one required parameter (query) with no further clarification, the description fails to add value.
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?
The description clearly states the action (search), the resource (local UserGate index), and the granularity (section/chunk). This distinguishes it from siblings like search_docs (whole documents) and get_doc_section (retrieve specific section).
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?
No guidance on when to use this tool versus alternatives. For example, it does not explain when to prefer search_doc_sections over search_docs or list of siblings. No context about prerequisites or typical use cases.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Tool Schema Changelog
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
18 tool updates
v0.1.0- First observed
get_doc - First observed
get_doc_section - First observed
get_project_status - First observed
list_documents_catalog - First observed
list_index_facets - First observed
list_pdf_catalog - First observed
prepare_auth_debug_pack - First observed
prepare_backup_ha_pack - First observed
prepare_captive_portal_pack - First observed
prepare_cert_lifecycle_pack - First observed
prepare_change_research - First observed
prepare_ops_platform_pack - First observed
prepare_routing_debug_pack - First observed
prepare_upgrade_plan - First observed
prepare_vpn_debug_pack - First observed
prepare_web_policy_pack - First observed
search_doc_sections - First observed
search_docs
TDQS
Scored across 18 tools
Each tool has a clearly distinct purpose: get_doc and get_doc_section target different granularities, list_ tools cover different catalog types and facets, and each prepare_* tool addresses a specific troubleshooting or planning scenario. There is no overlapping functionality.
Tool names follow a consistent verb_noun pattern (e.g., get_doc, list_documents_catalog, search_docs) with only minor deviations: 'prepare_change_research' lacks a 'pack' suffix unlike other prepare tools, and 'get_project_status' uses a slightly different noun structure. Overall naming is predictable and readable.
With 18 tools, the set is well-scoped for a documentation and troubleshooting pack server. It covers search, listing, retrieval, and specialized pack generation without being overwhelming or sparse.
The tool surface covers all expected operations for the domain: browsing catalogs, searching docs, retrieving content, and generating targeted troubleshooting packs. Minor gaps exist, such as no direct tool to list generated packs, but the core workflows are fully supported.
Maintenance
Related MCP Connectors
DocBase MCP server for AI agents
Personal knowledge base MCP server with semantic search, auto-categorization, metadata extraction
Document-to-Markdown MCP server — convert PDF, Office and HTML into LLM-ready Markdown.
Agent-native MCP server over the public saagarpatel.dev corpus. Read-only, stateless.
Related MCP Servers
- FlicenseNot gradedqualityDmaintenanceA simple Model Context Protocol server that enables searching and retrieving relevant documentation snippets from Langchain, Llama Index, and OpenAI official documentation.-
- FlicenseNot gradedqualityDmaintenanceA Model Context Protocol server for ingesting, chunking and semantically searching documentation files, with support for markdown, Python, OpenAPI, HTML files and URLs.-
- AlicenseAqualityDmaintenanceLocal-first RAG indexing and semantic search MCP server. Enables document retrieval and context-aware queries using local embedding models.36 npmMIT
- AlicenseNot gradedqualityDmaintenanceA production-ready Model Context Protocol server that bridges local document management with cloud synchronization (Notion) for AI agent integration, enabling seamless access and sync of local and cloud documents.11 npmMIT