cisco-umbrella-mcp
cisco-umbrella-mcp
Cisco Umbrella MCP Service — это статeless HTTP MCP-сервер, оборачивающий Cisco Umbrella REST API v2 (классический Umbrella, а не более новый продукт Secure Access/SASE), ограниченный 10 эндпоинтами, которые MSPbots использует в настоящее время: отчёты об активности DNS/proxy/firewall/AMP-retrospective, роуминг-компьютеры, обнаружение приложений (приложения/протоколы/категории приложений), список клиентов управляемого провайдера и сводка консоли провайдера.
Технологический стек: Python 3.12 + uv + FastMCP (Starlette/Uvicorn)
Когда агенту следует использовать этот сервис
Cisco Umbrella защищает сеть клиента на уровне DNS/веба — он блокирует вредоносные домены, фильтрует веб-контент по категориям и регистрирует сетевую активность. Агенту следует обращаться к этому MCP для запросов вроде:
«Был ли этот домен запрошен или заблокирован в сети этого клиента в последнее время?» →
cisco_umbrella_get_activity_dns«Какие веб-категории/URL фильтруются или проксируются для этого клиента?» →
cisco_umbrella_get_activity_proxy«Были ли разрешения/блокировки файрвола для сети этого клиента за последний день?» →
cisco_umbrella_get_activity_firewall«Был ли файл, который выглядел чистым, позже помечен как вредоносное ПО?» →
cisco_umbrella_get_activity_amp_retrospective«Перечисли роуминг-ноутбуки этого клиента и их последнюю синхронизацию/статус» →
cisco_umbrella_list_roaming_computers«Перечисли организации клиентов, которыми мы управляем через Cisco Umbrella» / «Каково наше использование пакетов Umbrella среди клиентов?» →
cisco_umbrella_list_customers,cisco_umbrella_get_providers_console
Оговорка: этот набор учётных данных — это ключ корневой организации Managed Provider (MSSP), а не учётные данные отдельного клиента, поэтому инструменты активности/устройств для конкретного клиента, перечисленные выше, на практике могут возвращать пустые результаты — см. раздел Известные пробелы ниже с проверенными деталями.
Related MCP server: cisco-secure-access-mcp
Примечание о методе аутентификации
Классический REST API Cisco Umbrella поддерживает грант OAuth2 client_credentials — чисто серверный обмен, без перенаправления через браузер пользователя. Администратор создаёт пару API Key + Key Secret в панели Umbrella (Admin > API Keys), и этот сервис обменивает эту пару на кратковременный (1 час) bearer-токен при каждом вызове (без refresh-токена, поэтому кэширования между запросами нет — тот же паттерн «повторный вход при каждом вызове», что и в covedataprotection-mcp/webroot-mcp/logmein-mcp).
POST https://api.umbrella.com/auth/v2/token
Authorization: Basic base64(apiKey:keySecret)
Content-Type: application/x-www-form-urlencoded
grant_type=client_credentialsПримечание о регионе: в собственной конфигурации интеграции MSPbots для Cisco Umbrella есть поле dataCenter (us/eu). Проверено напрямую по исходной спецификации OpenAPI, встроенной в документацию разработчика Cisco, для всех 10 эндпоинтов плюс эндпоинт auth/token: каждый из них указывает ровно один хост, https://api.umbrella.com — отдельного EU-хоста для классического Umbrella не существует. (В более новом продукте Cisco «Secure Access» действительно есть своя концепция регионов, но это другой продукт, не тот, на который нацелен этот сервис.) Поэтому этот сервис полностью игнорирует значение dataCenter; оно не нужно ни для одного из этих 10 эндпоинтов.
Быстрый старт
# Install dependencies
cd D:\claude\project\cisco-umbrella-mcp
uv sync
# Run in stdio mode (for Claude Desktop)
$env:UMBRELLA_API_KEY="your_api_key"
$env:UMBRELLA_KEY_SECRET="your_key_secret"
uv run cisco-umbrella-mcpКонфигурация
Скопируйте .env.example в .env и заполните свои значения:
Переменная | По умолчанию | Описание |
| — | Cisco Umbrella API Key (Admin > API Keys) |
| — | Cisco Umbrella Key Secret (показывается один раз при создании) |
|
|
|
|
|
|
|
| Порт HTTP-сервера |
HEADER 授权参数说明
В режиме Gateway каждый запрос должен содержать следующие два HTTP-заголовка:
Header | Тип | Обязателен | По умолчанию | Допустимые значения | Описание поля | Пример |
| string | да | нет | нет | Cisco Umbrella API Key (генерируется на странице Admin > API Keys в панели Umbrella) |
|
| string | да | нет | нет | Cisco Umbrella Key Secret (показывается только один раз при создании; используется вместе с API Key для обмена на токен через client_credentials) |
|
Настройка Claude Desktop
Добавьте в claude_desktop_config.json:
{
"mcpServers": {
"cisco-umbrella": {
"command": "uv",
"args": ["run", "--directory", "D:/claude/project/cisco-umbrella-mcp", "cisco-umbrella-mcp"],
"env": {
"UMBRELLA_API_KEY": "your_api_key",
"UMBRELLA_KEY_SECRET": "your_key_secret"
}
}
}
}Режимы транспорта
stdio (Claude Desktop / CLI)
$env:UMBRELLA_API_KEY="your_api_key"
$env:UMBRELLA_KEY_SECRET="your_key_secret"
uv run cisco-umbrella-mcpHTTP — одноклиентский
$env:UMBRELLA_API_KEY="your_api_key"
$env:UMBRELLA_KEY_SECRET="your_key_secret"
$env:MCP_TRANSPORT="http"
$env:AUTH_MODE="env"
uv run cisco-umbrella-mcpHTTP — gateway / мультитенантный
$env:MCP_TRANSPORT="http"
$env:AUTH_MODE="gateway"
uv run cisco-umbrella-mcp
# Each request must include: X-Umbrella-Api-Key and X-Umbrella-Key-Secret headersДоступные инструменты (10)
Инструмент | Описание | API | Параметры |
| События DNS-активности |
|
|
| События активности прокси (SWG) |
|
|
| События активности файрвола |
|
|
| События ретроспективной активности AMP |
|
|
| Список роуминг-клиентских конечных точек |
|
|
| Список обнаруженных облачных приложений |
|
|
| Список обнаруженных сетевых протоколов |
|
|
| Список категорий приложений |
|
|
| Список организаций клиентов в рамках этой учётной записи Managed Provider |
|
|
| Получить сводку подписки/использования консоли провайдера (один объект, не список) |
| нет |
from_/to принимают эпохальные миллисекунды, ISO-8601 или относительное смещение (например, "-1days", "-7days", "now"), в соответствии с соглашениями отчётного API Umbrella. (from_ имеет завершающее подчёркивание, потому что from — зарезервированное слово Python; внутри он сопоставляется с литеральным параметром запроса from.)
Известные пробелы
Протестировано на двух реальных учётных записях Managed Provider (MSSP). Из 10 инструментов только 2 подтверждённо работают с проверенными реальными данными; остальные 8 либо заблокированы, либо не проверены (пустые результаты не доказывают корректность — они просто означают, что ошибка не возникла).
✅ Подтверждённо работают (реальные, непустые, перекрёстно проверенные данные):
cisco_umbrella_get_providers_console— реальная сводка подписки на обеих тестовых учётных записях (customerCount: 77иcustomerCount: 47соответственно).cisco_umbrella_list_customers— вернул 77 реальных организаций клиентов (реальные названия компаний) на учётной записи 1. На учётной записи 2 завершился ошибкой403 Access Forbidden— подтверждено декодированием токена этой учётной записи, что ей действительно не хватает областиadmin.customers:read(всего 20 областей против 76 на учётной записи 1). Это не ошибка кода, а реальное различие в разрешениях между ключами.
⚠️ Не проверены — вернули корректно сформированные, но пустые результаты на обеих учётных записях, корректность не доказана: cisco_umbrella_get_activity_dns, _proxy, _firewall, _amp_retrospective, cisco_umbrella_list_roaming_computers. Определения параметров OpenAPI для Activity DNS были перекрёстно сверены напрямую с документацией Cisco (извлечена исходная спецификация, а не сводка) — from/to/limit реализованы точно так, как описано, отсутствующих или неправильно названных параметров нет. Вероятное объяснение: обе тестовые учётные записи — это корневые организации Managed Provider, у которых нет собственного прямого DNS/proxy/firewall/AMP-трафика или роуминг-компьютеров — эти данные находятся в каждой отдельной организации управляемого клиента. В документации Cisco был выполнен поиск параметра/заголовка ограничения области «запрос от имени организации этого клиента» для классического Umbrella — ничего не найдено (концепция ограничения области токена «Multi-Org» существует, но только для отдельного продукта Secure Access/SASE, а не для классического Umbrella). Существует отдельное семейство API «Providers» (/providers/customers/{customerId}/...), которое выглядит как возможный предполагаемый путь к данным конкретного клиента, но оно выходит за рамки подтверждённых для этой сборки 10 эндпоинтов. Для фактического подтверждения этих 5 инструментов требуются реальные учётные данные организации отдельного клиента (не уровня провайдера).
cisco_umbrella_list_applications,_protocols,_application_categories(App Discovery) — подтверждено, что заблокировано, это не ошибка кода. Воспроизводится идентично на обоих тестовых аккаунтах и при прямом вызове через curl с теми же токенами (что исключает проблемы с формированием запроса):403 Access Forbiddenна аккаунте 1,500/403на аккаунте 2. Списки областей действия обоих токенов включалиreports.appdiscovery:read, так что это, скорее всего, ограничение пакета/лицензии (App Discovery как платный дополнительный модуль не входит ни в один из тарифов «Umbrella for MSSPs» обоих аккаунтов), а не проблема прав доступа или параметров.cisco_umbrella_get_providers_consoleвозвращает один объект сводки по подписке, а не список — подтверждено обоими живыми тестами. Несмотря на множественное число в собственном сконфигурированном списке API в MSPbots («Providers Consoles»), перепроверьте это на соответствие тому, что ожидает существующий коллектор MSPbots (массив или одиночный объект).Список необязательных параметров конечной точки обнаружения приложений
Applicationsможет быть не полностью исчерпывающим (пара параметров ближе к концу схемы этой конечной точки не была полностью зафиксирована в ходе исследования) — задокументированные здесь (sources,identity,labels,controllable,categories,subcategory,limit,offset) подтверждены как реальные; возможно, есть ещё один-два, которые пока не добавлены.Область действия ограничена 10 операциями, которые MSPbots использует в настоящее время (подтверждено пользователем), а не всей поверхностью API Umbrella (которая также включает Networks, Internal Domains, Sites, Network Tunnels, Policies, Tagging, отдельный API «Providers» для действий по каждому клиенту и Key Admin API для управления самими ключами API).
Справочник по API
Available Tools
10 toolscisco_umbrella_get_activity_amp_retrospectiveA
List AMP (Advanced Malware Protection) retrospective activity events — files that were re-classified as malicious after they were first seen.
API: GET /reports/v2/activity/amp-retrospective
Args:
from_: Required. Start of the time range. Accepts epoch
milliseconds, ISO-8601 (e.g. "2024-01-01T00:00:00Z"), or a
relative offset (e.g. "-1days", "-7days", "now").
to: Required. End of the time range. Same accepted formats as from_.
limit: Max results per page (default 100).
offset: Pagination offset.
ampdisposition: Filter by AMP disposition, e.g. "malicious".
sha256: Filter by a specific file's SHA-256 hash.
timezone: IANA timezone name for the response's time fields.
| Name | Required | Description | Default |
|---|---|---|---|
| to | Yes | ||
| from_ | Yes | ||
| limit | No | ||
| offset | No | ||
| sha256 | No | ||
| timezone | No | ||
| ampdisposition | No |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description carries the burden. It mentions the API endpoint, default limit, and pagination offset, which hint at behavior. However, it does not disclose authentication needs, rate limits, or broader side effects (e.g., whether this is read-only). The word 'List' implies non-mutating, but that is implicit.
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 organized with a purpose line, API endpoint, and a list of args. It is front-loaded with the core purpose. It is longer than a simple two-liner but every line is informative. The structured arg list is easy to scan, though it could be slightly more concise if trimmed.
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 description covers purpose, endpoint, and all parameter semantics comprehensively. An output schema exists, so return values need no explanation. Missing pieces are explicit exclusions or caveats (e.g., 'not for DNS events') and any error/edge-case behavior. Overall it is complete for a list operation.
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 compensate. It does so thoroughly: from_ and to are explained with accepted formats (epoch ms, ISO-8601, relative offsets), limit has a default, offset is explained as pagination, ampdisposition has an example, sha256 is described, and timezone is defined. This adds significant meaning 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?
The description clearly states 'List AMP (Advanced Malware Protection) retrospective activity events' and explains what that means ('files that were re-classified as malicious after they were first seen'). This is a specific verb+resource+scope that distinguishes it from sibling activity tools like DNS, proxy, and firewall.
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 context is clear: this tool is for AMP retrospective events, which implies when to use it. However, it does not explicitly mention alternatives or exclusions relative to sibling activity tools. The description provides enough context for a basic selection decision, but lacks an explicit 'use this when' statement.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
cisco_umbrella_get_activity_dnsA
List DNS activity events.
API: GET /reports/v2/activity/dns
Args:
from_: Required. Start of the time range. Accepts epoch
milliseconds, ISO-8601 (e.g. "2024-01-01T00:00:00Z"), or a
relative offset (e.g. "-1days", "-7days", "now").
to: Required. End of the time range. Same accepted formats as from_.
limit: Max results per page (default 100).
offset: Pagination offset.
domains: Comma-separated domain filter.
categories: Comma-separated content category ID filter.
identityids: Comma-separated identity (e.g. roaming computer) ID filter.
verdict: Filter by verdict, e.g. "allowed" or "blocked".
threats: Comma-separated threat name filter.
timezone: IANA timezone name for the response's time fields.
| Name | Required | Description | Default |
|---|---|---|---|
| to | Yes | ||
| from_ | Yes | ||
| limit | No | ||
| offset | No | ||
| domains | No | ||
| threats | No | ||
| verdict | No | ||
| timezone | No | ||
| categories | No | ||
| identityids | No |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | 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 of behavioral disclosure. It correctly implies a read operation via 'List' and includes details on pagination (limit, offset), but it does not disclose potential side effects, rate limits, or authentication requirements. The API endpoint is provided, adding some transparency.
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 well-structured as a docstring with a one-line summary, followed by the API endpoint and a formatted list of arguments. Every parameter earns its place, and the content is front-loaded with the core purpose. It is appropriately concise for a tool with 10 parameters.
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 complexity (10 parameters, output schema present), the description is nearly complete. It covers all parameters, clarifies required fields, and notes timezone handling. It does not explain the response structure, but the output schema likely covers that. Minor gap: no mention of error handling or boundary behaviors.
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 descriptions are absent (0% coverage), so the description fully compensates by explaining each parameter's format and purpose. It clarifies time formats, defaults (limit 100), and filter types (domains, categories, verdict, etc.), providing clear semantics 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 opens with 'List DNS activity events,' which is a specific verb and resource that clearly identifies the tool's purpose. The name and API endpoint further specify DNS activity, distinguishing it from sibling tools like proxy, firewall, and AMP retrospective activity.
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 DNS activity events, but it does not explicitly state when to choose this tool over the sibling activity tools (e.g., proxy, firewall). No alternative tools are mentioned, so the guidance is implied rather than explicit.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
cisco_umbrella_get_activity_firewallA
List network firewall activity events.
API: GET /reports/v2/activity/firewall
Args:
from_: Required. Start of the time range. Accepts epoch
milliseconds, ISO-8601 (e.g. "2024-01-01T00:00:00Z"), or a
relative offset (e.g. "-1days", "-7days", "now").
to: Required. End of the time range. Same accepted formats as from_.
limit: Max results per page (default 100).
offset: Pagination offset.
identityids: Comma-separated identity (e.g. network tunnel) ID filter.
ruleid: Filter by firewall rule ID.
verdict: Filter by verdict, e.g. "allowed" or "blocked".
categories: Comma-separated category filter.
timezone: IANA timezone name for the response's time fields.
| Name | Required | Description | Default |
|---|---|---|---|
| to | Yes | ||
| from_ | Yes | ||
| limit | No | ||
| offset | No | ||
| ruleid | No | ||
| verdict | No | ||
| timezone | No | ||
| categories | No | ||
| identityids | No |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description carries the full burden. It discloses the API method (GET) and the required time-range parameters, but does not explicitly state safety (e.g., read-only) or discuss behaviors like pagination limits, result ordering, or rate limits. The 'List' verb and GET API imply a non-destructive operation, but this is not spelled out.
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 concise and well-structured. It opens with a one-line purpose, gives the API endpoint, and then lists parameters in a readable format. Every sentence adds value; there is no fluff or redundancy.
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 description covers all parameters, required fields, and accepted formats, and an output schema exists so return values need no explanation. It could also mention explicit when-to-use vs. sibling tools, but that falls more under usage guidelines. Overall, it is sufficiently complete for a list operation with good parameter coverage.
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 0% description coverage, so the description is the only source of parameter meaning. It provides detailed semantics for every parameter: accepted time formats for from_/to, default for limit, offset as pagination, and definitions for each filter (identityids, ruleid, verdict, categories, timezone). This fully compensates for the schema's lack of 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 starts with 'List network firewall activity events,' which uses a specific verb and resource. It clearly distinguishes itself from sibling tools like get_activity_dns and get_activity_proxy by specifying 'firewall.'
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 that this tool is for firewall activity events, but it does not explicitly state when to use it over the sibling activity tools or mention any exclusions. The usage context is clear enough from the name and first line, but no alternatives or when-not-to-use guidance is provided.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
cisco_umbrella_get_activity_proxyA
List proxy (Secure Web Gateway) activity events.
API: GET /reports/v2/activity/proxy
Args:
from_: Required. Start of the time range. Accepts epoch
milliseconds, ISO-8601 (e.g. "2024-01-01T00:00:00Z"), or a
relative offset (e.g. "-1days", "-7days", "now").
to: Required. End of the time range. Same accepted formats as from_.
limit: Max results per page (default 100).
offset: Pagination offset.
domains: Comma-separated domain filter.
urls: Comma-separated URL filter.
categories: Comma-separated content category ID filter.
identityids: Comma-separated identity ID filter.
verdict: Filter by verdict, e.g. "allowed" or "blocked".
threats: Comma-separated threat name filter.
filename: Filter by downloaded file name.
timezone: IANA timezone name for the response's time fields.
| Name | Required | Description | Default |
|---|---|---|---|
| to | Yes | ||
| urls | No | ||
| from_ | Yes | ||
| limit | No | ||
| offset | No | ||
| domains | No | ||
| threats | No | ||
| verdict | No | ||
| filename | No | ||
| timezone | No | ||
| categories | No | ||
| identityids | No |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description carries the burden. It discloses the HTTP method (GET) and details about timezone handling and pagination, which is useful. However, it does not explicitly state that this is a read-only operation, mention authentication requirements, or describe error behavior, leaving some gaps.
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 well-structured docstring with the API endpoint followed by an Args list. Each parameter gets a single concise line, and the content is front-loaded with the core action. No wasted words.
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?
Despite having 12 parameters and no schema descriptions, the description covers every parameter, the API endpoint, and special formatting details for time fields and timezone. An output schema exists, so return values are presumably covered there. It is complete for a reporting tool of this complexity.
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 fully compensates by explaining every parameter, including accepted formats for from_/to (epoch, ISO-8601, relative offsets), default values, and filter semantics with examples (e.g., verdict 'allowed' or 'blocked'). This adds substantial meaning beyond the raw 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 it 'List proxy (Secure Web Gateway) activity events', providing a specific verb and resource. The term 'proxy' differentiates it from sibling tools that focus on DNS, firewall, or AMP activities.
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 gives no explicit guidance on when to use this tool versus alternatives like DNS or firewall activity tools. While the name and description imply proxy/SWG reporting, there are no when-to-use or when-not-to-use statements, and no alternatives are mentioned.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
cisco_umbrella_get_providers_consoleA
Get this Umbrella Managed Provider console's subscription/usage summary (package name, total/used seats, customer count, status, renewal/expiry dates). Not a list — returns a single object.
API: GET /reports/v2/providers/consoles
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Since no annotations are provided, the description carries the full burden. It discloses the HTTP method (GET), the fact that it returns a single object, and the summary contents, which are meaningful behavioral traits. It does not mention authentication, errors, or rate limits, but for a simple read-only report call with no parameters, the added context is strong.
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 concise: a single main sentence with a parenthetical list, a clarifying sentence about the return type, and an API reference. Every line adds value, with no redundant or filler text.
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 zero-parameter read-only tool, the description is complete: it states the purpose, the return value's scope, the single-object semantics, and provides the exact API endpoint. The output schema covers detailed return values, so the description need not repeat them, and the simplicity of the tool means no additional context is required.
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 no properties, so the baseline is 4. The description does not need to explain parameters because there are none; it appropriately focuses on the output and semantics.
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 identifies the tool as retrieving 'this Umbrella Managed Provider console's subscription/usage summary' and enumerates the specific fields (package name, seats, customer count, status, dates). The phrase 'Not a list — returns a single object' explicitly differentiates it from the sibling list tools, meeting the requirement for a specific verb+resource and sibling distinction.
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 clear context: it is for obtaining the console's subscription/usage summary and emphasizes that it returns a single object rather than a list, which helps choose it over list-oriented siblings. However, it does not explicitly name alternative tools or state when not to use it, so it falls slightly short of a 5.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
cisco_umbrella_list_application_categoriesB
List application categories (App Discovery).
API: GET /reports/v2/appDiscovery/applicationCategories
Args:
limit: Max results per page (1-100).
offset: Pagination offset.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | ||
| offset | No |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
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 includes the GET API endpoint, implying read-only, but fails to disclose pagination behavior, return format, permissions, rate limits, or other behavioral traits. The description stays at the surface level without revealing operational 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?
The description is concise and well-structured: a clear purpose statement, the API endpoint, and an Args section with parameter details. Each line earns its place, with no filler, and the format is easily scannable.
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 an output schema present, return values need not be explained. The description covers the core function and parameters, making it minimally viable for a simple list operation. However, it lacks any usage context, behavioral detail, or operational constraints, leaving gaps in full understanding.
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 adds valuable parameter semantics: 'limit: Max results per page (1-100)' and 'offset: Pagination offset.' This goes beyond the schema, which has 0% description coverage and only provides types and defaults. The range and purpose of parameters are clarified.
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 'List application categories (App Discovery).' with a specific verb and resource, and also provides the API endpoint for added clarity. However, it does not explicitly differentiate from sibling tools like 'cisco_umbrella_list_applications', though the resource name is distinct enough to infer.
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 given about when to use this tool versus alternatives such as 'cisco_umbrella_list_applications' or other list tools. There is no context on use cases, prerequisites, or when not to use it, so the usage guidance is absent.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
cisco_umbrella_list_applicationsA
List discovered cloud applications (App Discovery).
API: GET /reports/v2/appDiscovery/applications
Args:
sources: Comma-separated data source filter, e.g. "dns,swg,cdfw".
identity: Filter by identity (e.g. roaming computer or network) ID.
labels: Comma-separated label filter.
controllable: Filter to only applications with a controllable policy.
categories: Comma-separated application category ID filter.
subcategory: Filter by application subcategory.
limit: Max results per page.
offset: Pagination offset.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | ||
| labels | No | ||
| offset | No | ||
| sources | No | ||
| identity | No | ||
| categories | No | ||
| subcategory | No | ||
| controllable | No |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description carries the full burden for behavioral disclosure. It only states 'List' and lists parameters, but does not describe pagination behavior (e.g., default limit, max results), response structure, or any side effects beyond it being a read operation.
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 well-structured with a one-line summary, API endpoint, and a clear list of args. It is concise and free of extraneous information, though the API line is somewhat redundant with the tool name.
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 list operation with an output schema, the description covers all parameters and the core purpose, but lacks usage guidance and behavioral details like pagination defaults. The output schema presumably covers return values, so the description is reasonably complete.
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?
All eight parameters are described with meaningful detail beyond the schema, including value formats (comma-separated, boolean), examples (sources: 'dns,swg,cdfw'), and semantics (limit as max results per page). Since schema coverage is 0%, this description fully compensates.
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 'List discovered cloud applications (App Discovery).' with a clear verb and resource, and includes the API endpoint. This clearly distinguishes it from sibling tools like list_application_categories or get_activity_*.
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?
Provides no guidance on when to use this tool versus alternatives such as activity reporting or category listing. There is no mention of prerequisites, exclusions, or when not to use it.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
cisco_umbrella_list_customersA
List customer organizations under this Umbrella Managed Provider (MSP) account.
API: GET /admin/v2/managed/customers
Args:
page: Page number (default 1).
limit: Max results per page (default 100, max 100).
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | ||
| limit | No |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description carries the burden. The 'List' verb and 'GET' API endpoint indicate a read-only operation, and the max limit of 100 is disclosed. However, it does not mention authentication requirements, rate limits, or behavior beyond pagination, leaving some transparency gaps.
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 extremely concise and well-structured: purpose in the first line, API endpoint for reference, then a clear args list. Every sentence provides value without redundancy.
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 simplicity, an output schema exists (so return values are covered), the description adequately covers purpose, scope, endpoint, and parameters. It lacks explicit guidance on when to prefer this tool over siblings, but it is otherwise complete for a straightforward list operation.
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, the description fully compensates by explaining both parameters: page is the page number (default 1), and limit is max results per page (default 100, max 100). It adds the max constraint not present in 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 tool lists customer organizations under the MSP account, using a specific verb ('List') and resource ('customer organizations'). It distinguishes itself from sibling tools that list other entities like roaming computers, applications, or protocols.
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 clear context that this is for the Umbrella Managed Provider (MSP) account, implying it should be used when the agent needs to see managed customer organizations. It does not explicitly mention when not to use it or name alternatives, but the MSP-specific scope differentiates it from sibling list tools.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
cisco_umbrella_list_protocolsA
List discovered network protocols (App Discovery).
API: GET /reports/v2/appDiscovery/protocols
Args:
identity: Filter by identity (e.g. roaming computer or network) ID.
limit: Max results per page.
offset: Pagination offset.
sort: Sort field — "firstDetected" or "lastDetected".
order: Sort order — "asc" or "desc".
| Name | Required | Description | Default |
|---|---|---|---|
| sort | No | ||
| limit | No | ||
| order | No | ||
| offset | No | ||
| identity | No |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description carries the transparency burden. It discloses the HTTP method (GET) and the endpoint, implying read-only, and documents each parameter's meaning. However, it does not address pagination behavior limits, authentication, or other operational caveats, leaving some gaps.
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 compact and front-loaded with the core purpose, followed by the API endpoint and a structured Args list. No redundant sentences; every element serves a purpose.
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 an output schema, so return values are covered. The description explains all parameters and the endpoint. It lacks explicit cross-tool guidance, but overall it is sufficiently complete for a straightforward list operation.
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%, so the description must compensate. It does so thoroughly via an Args section that explains identity filtering, pagination, sort fields, and order values, adding substantial meaning 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?
The description opens with 'List discovered network protocols (App Discovery),' providing a specific verb, resource, and context. This clearly distinguishes it from sibling tools like list_applications and list_application_categories by focusing on protocols.
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 identifies the App Discovery domain but does not explicitly explain when to choose this over list_applications or list_application_categories. Usage is implied by the tool name and resource, but no exclusions or alternatives are mentioned.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
cisco_umbrella_list_roaming_computersA
List roaming computers (endpoints running the Umbrella roaming client).
API: GET /deployments/v2/roamingcomputers
Args:
page: Page number (default 1).
limit: Max results per page (default 100, max 100).
name: Filter by computer name (partial match).
status: Filter by status.
swg_status: Filter by Secure Web Gateway module status.
last_sync_before: Only computers that last synced before this time.
last_sync_after: Only computers that last synced after this time.
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | ||
| page | No | ||
| limit | No | ||
| status | No | ||
| swg_status | No | ||
| last_sync_after | No | ||
| last_sync_before | No |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The description discloses the HTTP method (GET), pagination via page and limit, and filter semantics. However, in the absence of annotations, it does not explicitly state read-only nature, authentication needs, or behavior like how filters combine. Some behavioral traits are covered, but not all.
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 well-structured and front-loaded: purpose first, then API endpoint, then a clear list of arguments. Every sentence contributes useful information without redundancy or fluff. The layout is scannable 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?
The description covers the main purpose, endpoint, all parameters, and pagination. Since an output schema exists, the absence of response format details is acceptable. It could go further by specifying allowed filter values and date/time formats, but overall it is complete enough for a list tool.
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?
Given schema description coverage is 0%, the description compensates by explaining each of the 7 parameters with meaningful details: defaults, max limit, partial matches for name, and the semantics of last_sync_before/after. It lacks allowed values for status and date formats, but provides substantial value 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?
The description starts with a specific verb 'List' and resource 'roaming computers', and clarifies in parentheses that these are endpoints running the Umbrella roaming client. This clearly distinguishes it from sibling tools like activity or application list tools.
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 makes the tool's purpose clear but does not explicitly state when to use it versus alternatives or mention exclusions. Sibling tools are quite different, so usage is implied, but no direct guidance or alternative routing is provided.
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.
10 tool updates
v0.1.0- First observed
cisco_umbrella_get_activity_amp_retrospective - First observed
cisco_umbrella_get_activity_dns - First observed
cisco_umbrella_get_activity_firewall - First observed
cisco_umbrella_get_activity_proxy - First observed
cisco_umbrella_get_providers_console - First observed
cisco_umbrella_list_application_categories - First observed
cisco_umbrella_list_applications - First observed
cisco_umbrella_list_customers - First observed
cisco_umbrella_list_protocols - First observed
cisco_umbrella_list_roaming_computers
TDQS
Scored across 10 tools
Each tool targets a distinct resource and action: four activity types (DNS, proxy, firewall, AMP), app discovery resources (applications, protocols, categories), roaming computers, and MSP-specific data (customers, console). No two tools appear to overlap in purpose.
All tools follow a consistent cisco_umbrella_<verb>_<noun> pattern with snake_case. The verb varies logically: 'get' for single objects or specific activity endpoints, 'list' for collection endpoints. This is highly predictable.
10 tools is well-scoped for an umbrella security API server: it covers several distinct functional areas (activity events, app discovery, roaming computers, MSP management) without becoming unwieldy. Each tool serves a clear purpose.
The set provides broad read-only access to multiple domains: activity reporting, app discovery, roaming computer lists, and MSP summary. It lacks individual item retrieval or management operations (e.g., get by ID, create/update/delete), but for a read-only reporting server this is a minor gap rather than a fatal one.
Maintenance
Related MCP Connectors
Cybersecurity MCP server for URL scanning, threat intelligence, and domain reputation.
ThousandEyes MCP Server for network intelligence: outages, anomalies, alerts, events, and tests.
MCP server for querying and analyzing data from ad platforms, analytics tools, and spreadsheets
MCP server providing attendance data queries via the CloudTime API.
Related MCP Servers
- AlicenseCqualityBmaintenanceA Python-based MCP server that enables querying Cisco's Meraki Dashboard API to discover, monitor, and manage Meraki environments.2245MIT
- AlicenseAqualityDmaintenanceA community MCP server for Cisco Secure Access that exposes the Secure Access REST API to AI clients as a curated catalog of tools for Admin, Deployments, Investigate, Policies, and Reports.421Apache 2.0
- AlicenseBqualityAmaintenanceMCP server for Proofpoint Email Protection - email security, threat intelligence, TAP (Targeted Attack Protection), and email filtering API integration405Apache 2.0
- AlicenseNot gradedqualityBmaintenanceA read-only MCP server for Cisco Meraki Dashboard, enabling LLMs to discover devices, check health, troubleshoot, and generate reports via natural language.MIT