Skip to main content
Glama
mcp-server-worldquantbrain

mcp-server-worldquantbrain

Update alpha properties

update_alpha
Idempotent

Update an alpha's name, description, tags, color, category, favorite, or hidden flag by providing its BRAIN alpha ID.

Instructions

Change an alpha's name, description, tags, color, category, favorite or hidden flag.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "alpha_id": "<alpha_id>"
    },
    "name": "update_alpha"
  }
}

Input Schema

NameRequiredDescriptionDefault
nameNo
tagsNo
colorNoRED, YELLOW, GREEN, BLUE or PURPLE.
hiddenNo
alpha_idYesBRAIN alpha id, for example 'qMPjAxnO'.
categoryNo
favoriteNo
descriptionNo

Output Schema

NameRequiredDescriptionDefault
idYes
nameNo
tagsNo
typeNo
colorNo
decayNo
delayNo
gradeNo
stageNo
checksNo
hiddenNo
regionNo
statusNo
categoryNo
favoriteNo
universeNo
in_sampleNo
expressionNo
truncationNo
descriptionNo
date_createdNo
failed_checksNo
out_of_sampleNo
date_submittedNo
neutralizationNo
warning_checksNo
instrument_typeNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

C2.7/5.0
Behavior2/5

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

Annotations already cover the safety profile (readOnlyHint=false, idempotentHint=true, destructiveHint=false, openWorldHint=true), so the description's main remaining burden is update semantics. It says nothing about whether this is a partial update, whether null-valued fields are left unchanged or cleared, or whether omitted fields are preserved — a critical behavior for an 8-param mutation tool.

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?

A single front-loaded sentence with zero waste. Brevity is appropriate for the format, though the sentence is thin rather than dense with useful information.

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 a mutation tool with 8 parameters, 25% schema coverage, and no output explanation needed (an output schema exists), the description should at minimum clarify null/omission semantics. As written, an agent cannot tell whether passing name but not tags wipes the tags, which is enough of a gap to risk incorrect calls.

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

Parameters2/5

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

Schema description coverage is only 25% (only alpha_id's format and color's enum are documented). The description merely echoes the schema property names (name, description, tags, color, category, favorite, hidden) without adding meaning, and never explains the pervasive default:null semantics or that unsupplied fields are untouched.

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

Purpose4/5

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

"Change an alpha's name, description, tags, color, category, favorite or hidden flag" gives a specific verb (change) and resource (alpha), plus the exact editable fields. An agent can distinguish this from read-only siblings like get_alpha or list_alphas by the mutation framing alone, though no sibling is named explicitly.

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 / when-not-to-use guidance and no mention of alternatives or prerequisites (e.g., that the alpha must already exist, or that alpha_id comes from list_alphas). Usage is only implied by the verb 'change'.

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