Skip to main content
Glama
mcp-server-worldquantbrain

mcp-server-worldquantbrain

Get production correlation

get_alpha_prod_correlation
Read-onlyIdempotent

Retrieve an alpha's correlation with the production pool to check overlap before submitting. Supports a wait time for computation; some account tiers receive a 403.

Instructions

Return the alpha's correlation with the production pool. Some account tiers get a 403.

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": "get_alpha_prod_correlation"
  }
}

Input Schema

NameRequiredDescriptionDefault
alpha_idYesBRAIN alpha id, for example 'qMPjAxnO'.
wait_secondsNo

Output Schema

NameRequiredDescriptionDefault
topNo
kindYes
countNo
passesNo
pendingNo
alpha_idYes
next_stepNo
thresholdYes
max_correlationNo
min_correlationNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3.1/5.0
Behavior3/5

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

The annotations already establish that this is a read-only, idempotent, non-destructive, open-world operation. The description adds useful behavioral context by warning that some account tiers receive a 403, but it does not explain the wait_seconds polling behavior or what the returned correlation represents.

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?

Two short sentences, with the primary purpose front-loaded and the permission caveat immediately after. There is no unnecessary wording.

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

Completeness3/5

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

The output schema and annotations carry much of the burden, but the description leaves wait_seconds unexplained and does not clarify how to handle the 403 condition. For a simple two-parameter tool this is adequate but incomplete.

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?

The description adds no meaning for either parameter. The alpha_id schema is documented with an example, but wait_seconds has no description beyond its numeric bounds and default, leaving half the parameters semantically unexplained.

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?

The description states a specific verb and resource: return the alpha's correlation with the production pool. This is clear enough to distinguish it from general alpha retrieval, though it does not explicitly differentiate it from the sibling get_alpha_self_correlation.

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?

The description provides no explicit guidance on when to choose this tool over get_alpha_self_correlation or other correlation-related siblings. The 403 note is a permission caveat, not usage selection guidance.

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