Skip to main content
Glama

Edit an alert

update_alert
Destructive

Edits the interest, or pauses or turns on again an alert of the owner. The filters replace the whole filter.

Input Schema

NameRequiredDescriptionDefault
idYesAlert identifier.
ufNoState (UF) abbreviation; empty means all.
nomeNoAlert name, up to 100 characters.
ativoNo`false` pauses without deleting; `true` turns it on again.
canalNoNew channel: `pull`, `webhook` or `email`. Email requires a session and uses explicit recipients or the account email.
termosNoObject terms; a space requires all words, | accepts alternatives.
destinoNoNew https URL on port 443 (webhook). Ignored for pull and email.
filtrosNoExtra filter: modalities, municipalities, exclusions, values, open proposals and CNAEs. PATCH replaces the whole filter; {} clears it.
resultadosNoAlso deliver the result of each matching purchase when PNCP publishes it, on the same channel: the purchase comes back once with `resultado` (awarded value, items, date and the three largest winners). It starts when turned on, without past results. `abertas` does not apply to results.
destinatariosNoEmail recipients: `para`, `cc` and `bcc` arrays. Up to 10 distinct addresses in total. An empty `para` list uses the account email. PATCH replaces all three lists. BCC is hidden from other recipients.
organizacao_idNoOrganization from `GET /api/me/empresas`. Membership and MFA are checked. Null removes the label. This does not share alert ownership.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed13 schema fields changed
    • addedInput schema / properties / destinatarios / properties / bcc / description
      Added value: +"Hidden copy addresses. Only the alert owner can read this list."
    • addedInput schema / properties / destinatarios / properties / cc / description
      Added value: +"Visible copy addresses."
    • addedInput schema / properties / destinatarios / properties / para / description
      Added value: +"To addresses. An empty list uses the verified account email."
    • addedInput schema / properties / filtros / properties / abertas / description
      Added value: +"Require the proposal deadline to be open at collection time."
    • addedInput schema / properties / filtros / properties / cnaes / description
      Added value: +"Up to 8 CNAE subclasses, such as 4644301 or 4644-3/01. Matches one of the purchase's three most likely CNAEs."
    • addedInput schema / properties / filtros / properties / disputa / description
      Added value: +"Only purchases with competitive bidding. Excludes PNCP's not-applicable bidding mode."
    • addedInput schema / properties / filtros / properties / esferas / description
      Added value: +"Government spheres: F federal, E state, D district and M municipal. Records without a sphere are excluded."
    • addedInput schema / properties / filtros / properties / excluir / description
      Added value: +"Up to 10 literal phrases, each 3–80 characters, to exclude from the purchase subject."
    • addedInput schema / properties / filtros / properties / modalidades / description
      Added value: +"Up to 10 PNCP procedure codes, from 1 to 19."
    • addedInput schema / properties / filtros / properties / municipios / description
      Added value: +"Up to 10 exact municipality names or IBGE codes. Use UF to distinguish names."
    • addedInput schema / properties / filtros / properties / srp / description
      Added value: +"Only purchases marked as price registration (srp) by PNCP."
    • addedInput schema / properties / filtros / properties / valor_max / description
      Added value: +"Maximum estimated value in Brazilian reais."
    • addedInput schema / properties / filtros / properties / valor_min / description
      Added value: +"Minimum estimated value in Brazilian reais."
  2. Changed4 schema fields changed
    • addedInput schema / properties / filtros / properties / disputa
      Added value: +{
      +  "type": "boolean"
      +}
    • addedInput schema / properties / filtros / properties / esferas
      Added value: +{
      +  "items": {
      +    "enum": [
      +      "F",
      +      "E",
      +      "D",
      +      "M"
      +    ],
      +    "type": "string"
      +  },
      +  "maxItems": 10,
      +  "type": "array"
      +}
    • addedInput schema / properties / filtros / properties / srp
      Added value: +{
      +  "type": "boolean"
      +}
    • addedInput schema / properties / resultados
      Added value: +{
      +  "description": "Also deliver the result of each matching purchase when PNCP publishes it, on the same channel: the purchase comes back once with `resultado` (awarded value, items, date and the three largest winners). It starts when turned on, without past results. `abertas` does not apply to results.",
      +  "type": "boolean"
      +}
  3. Changed4 schema fields changed
    • changedInput schema / properties / canal / description
      Previous value: -"New channel: `pull`, `webhook` or `email` (the verified e-mail of the account; requires a session)."New value: +"New channel: `pull`, `webhook` or `email`. Email requires a session and uses explicit recipients or the account email."
    • addedInput schema / properties / destinatarios
      Added value: +{
      +  "additionalProperties": false,
      +  "description": "Email recipients: `para`, `cc` and `bcc` arrays. Up to 10 distinct addresses in total. An empty `para` list uses the account email. PATCH replaces all three lists. BCC is hidden from other recipients.",
      +  "properties": {
      +    "bcc": {
      +      "items": {
      +        "format": "email",
      +        "maxLength": 254,
      +        "type": "string"
      +      },
      +      "maxItems": 10,
      +      "type": "array"
      +    },
      +    "cc": {
      +      "items": {
      +        "format": "email",
      +        "maxLength": 254,
      +        "type": "string"
      +      },
      +      "maxItems": 10,
      +      "type": "array"
      +    },
      +    "para": {
      +      "items": {
      +        "format": "email",
      +        "maxLength": 254,
      +        "type": "string"
      +      },
      +      "maxItems": 10,
      +      "type": "array"
      +    }
      +  },
      +  "type": "object"
      +}
    • addedInput schema / properties / nome
      Added value: +{
      +  "description": "Alert name, up to 100 characters.",
      +  "maxLength": 100,
      +  "type": "string"
      +}
    • addedInput schema / properties / organizacao_id
      Added value: +{
      +  "description": "Organization from `GET /api/me/empresas`. Membership and MFA are checked. Null removes the label. This does not share alert ownership.",
      +  "type": [
      +    "string",
      +    "null"
      +  ]
      +}
  4. Added

TDQS

C2.8/5.0
Behavior3/5

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

Annotations already declare destructiveHint=true, idempotentHint=false and openWorldHint=true, so the safety profile is covered. The description's one real contribution is "The filters replace the whole filter", a replacement-semantics warning that matters for a destructive edit, though the same fact is repeated in the `filtros` schema description. It says nothing about whether unspecified fields are preserved, which is the key behavioral risk here.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two short sentences with no filler, and the core operation plus the filter-replacement caveat are front-loaded. It is efficient, though the first sentence's phrasing is awkward rather than crisp.

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

Completeness2/5

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

For an 11-parameter destructive mutation with two nested objects and no output schema, two sentences are thin. Critical questions remain unanswered by the description: whether omitting a field leaves it unchanged or clears it (only `filtros` is stated to replace wholesale, and `destinatarios` replacement is only in the schema), and what happens on invalid webhook URLs or organization changes.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so all 11 parameters, including the nested `filtros` and `destinatarios` objects, are documented in the schema itself. The description adds no field-level meaning beyond the filter-replacement note. Baseline 3 applies when the schema carries the semantic load.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose3/5

Does the description clearly state what the tool does and how it differs from similar tools?

"Edits ... an alert of the owner" states a verb and resource, and "pauses or turns on again" clarifies the toggle use case. However, "edits the interest" is opaque jargon, and the description never distinguishes this from siblings like create_alert or preview_alert, which an agent must guess between.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

There is no when-to-use guidance, no prerequisites (ownership, authentication, channel session), and no pointer to an alternative such as create_alert for new alerts. The only usage signal is implicit in "pauses or turns on again", which an agent must map onto the `ativo` field.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.