mcp-server-worldquantbrain

Overview Schema Source Related Servers Discussions Admin

Get an alpha recordset

get_alpha_recordset

Read-onlyIdempotent

Retrieve a named recordset (like yearly-stats) for a BRAIN alpha by alpha_id, limiting to the last N rows. Use get_alpha_pnl for PnL data.

Instructions

Return one recordset as named rows. Prefer get_alpha_pnl for PnL.

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": "<name>"
    },
    "name": "get_alpha_recordset"
  }
}

Input Schema

Name	Required	Description
`name`	Yes	Recordset, e.g. yearly-stats.
`alpha_id`	Yes	BRAIN alpha id, for example 'qMPjAxnO'.
`max_rows`	No	Keep the last N rows.

Output Schema

Name	Required	Description	Default
`name`	Yes
`rows`	Yes
`columns`	Yes
`alpha_id`	Yes
`truncated`	No
`total_rows`	Yes

Schema Changelog

Changes observed during successful MCP inspections.

First observedv0.1.0Nov 11, 2026

TDQS

A3.8/5.0

Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, openWorldHint and destructiveHint=false, so the safety profile is fully covered. The description adds only the return shape hint ("named rows"). It says nothing about how open-world recordset names behave or what happens when a name is unknown.

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, no filler, with the primary purpose front-loaded and the disambiguation second. Nothing could be removed without losing information.

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?

An output schema exists, so return values need not be explained, and annotations cover the safety profile; for a simple three-parameter read tool this is nearly sufficient. The remaining gap is discovery: it never points at the sibling that lists available recordset names.

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 alpha_id, name and max_rows (including the "last N rows" semantics and the 1-500 bound) are already documented in the schema. The description adds no extra meaning for any parameter; baseline 3 applies.

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 one recordset as named rows") and implicitly contrasts with the plural listing sibling. It is clear what you get, though it never names list_alpha_recordsets as the way to discover valid recordset names.

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?

It gives an explicit alternative and the condition selecting it: "Prefer get_alpha_pnl for PnL." That is real routing guidance. It stops short of full when/when-not coverage, giving no hint that list_alpha_recordsets is how you enumerate the valid `name` values before calling.

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