Skip to main content
Glama
longbridge

longbridge

Official

Update Watchlist Group

update_watchlist_group
DestructiveIdempotent

Update a watchlist group by ID, renaming it or modifying its securities with add, remove, or replace modes.

Instructions

Update a watchlist group by id. Can rename (name param) or modify securities (securities + mode: add/remove/replace).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesWatchlist group id
_jqNoOptional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the `env`/`debug`/`stderr` builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.
modeNoUpdate mode for securities: "add", "remove", or "replace" (default: "replace")
nameNoNew group name (optional)
securitiesNoSecurities list (optional)

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv0.12.0
    • addedInput schema / properties / _jq / description
      Added value: +"Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the `env`/`debug`/`stderr` builtins are unavailable. Example: .data | map({symbol}). Omit for the full response."
    • removedInput schema / properties / id / format
      Removed value: -"int64"
  2. Changed2 schema fields changedv0.10.6
    • addedInput schema / properties / _jq
      Added value: +{
      +  "type": "string"
      +}
    • changedOutput schema / (root)
      Previous value: -{
      -  "properties": {
      -    "id": {
      -      "format": "int64",
      -      "type": "integer"
      -    },
      -    "updated": {
      -      "type": "boolean"
      -    }
      -  },
      -  "required": [
      -    "id",
      -    "updated"
      -  ],
      -  "type": "object"
      -}New value: +null
  3. Changed1 schema field changedv0.7.1
    • removedInput schema / title
      Removed value: -"UpdateWatchlistGroupParam"
  4. Changed5 schema fields changedv0.6.0
    • removedOutput schema / $schema
      Removed value: -"https://json-schema.org/draft/2020-12/schema"
    • removedOutput schema / description
      Removed value: -"Returned by `update_watchlist_group`."
    • removedOutput schema / properties / id / description
      Removed value: -"The updated watchlist group ID (echoed from the request)."
    • removedOutput schema / properties / updated / description
      Removed value: -"Always `true` on success."
    • removedOutput schema / title
      Removed value: -"UpdateWatchlistGroupResponse"
  5. Changed1 schema field changedv0.5.6
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "$schema": "https://json-schema.org/draft/2020-12/schema",
      +  "description": "Returned by `update_watchlist_group`.",
      +  "properties": {
      +    "id": {
      +      "description": "The updated watchlist group ID (echoed from the request).",
      +      "format": "int64",
      +      "type": "integer"
      +    },
      +    "updated": {
      +      "description": "Always `true` on success.",
      +      "type": "boolean"
      +    }
      +  },
      +  "required": [
      +    "id",
      +    "updated"
      +  ],
      +  "title": "UpdateWatchlistGroupResponse",
      +  "type": "object"
      +}
  6. Addedv0.4.5
  7. Removedv0.4.0
  8. Addedv0.3.2
  9. Removedv0.3.1
  10. First observedv0.1.12

TDQS

A4.4/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=false and destructiveHint=true; the description builds on this by explicitly naming the destructive operations (remove/replace) and the default replace mode, which implies replacing the securities list. This adds meaningful behavioral detail beyond the flags and does not contradict any annotation.

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

Conciseness5/5

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

The description is a single sentence with a front-loaded target and a compact enumeration of operations. There is no redundant wording, and every clause contributes to understanding what the tool does.

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

Completeness4/5

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

For a five-parameter update tool with full schema coverage and rich annotations, the description is nearly complete. The main gap is that it does not describe return values or post-conditions, and there is no output schema, but the mutation semantics and parameters are clear enough for correct invocation.

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

Parameters4/5

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

All five parameters are documented in the schema, so the baseline is 3. The description adds value by linking 'name' to the rename operation and 'securities + mode' to add/remove/replace, clarifying the intended parameter combinations and that these are independent update paths.

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

Purpose5/5

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

The description opens with a specific verb and resource, 'Update a watchlist group by id', and then enumerates the two update operations: renaming and modifying securities. This distinguishes it from sibling tools like create_watchlist_group and delete_watchlist_group without needing to open their schemas.

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

Usage Guidelines4/5

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

The description gives clear usage context: use this tool when renaming a group or changing its securities via add/remove/replace, and the id is required. It does not explicitly name alternatives or provide when-not-to-use guidance, but the purpose is unambiguous enough that an agent can decide correctly.

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

Deploy Server

Other Tools