Skip to main content
Glama

Algo Trade Analytics

Get Research Notebook

ata_get_research_notebook
Read-onlyIdempotent

Return a bounded, sanitized Algo Agent research notebook for a case study or research run, including journal records, evidence, maturity, lessons, and recent run items.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
limitNo
caseStudyIdNo
researchRunIdNo
includeRunItemPayloadsNo
includeMaturityByVersionNo
includeCandidateScriptSourceNoInclude each candidate's full Pine scriptSource. Off by default because sources dominate the payload; enable to recover a candidate's exact source after context loss. Prefer a small limit when enabling.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.6/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint, and non-destructive behavior; the description adds useful context with 'bounded' (implies size limits) and 'sanitized' (implies redaction). It does not detail pagination or output shape, but the annotations lower the bar.

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?

A single front-loaded sentence that communicates the resource, scope, and contents without redundancy. Every phrase earns its place.

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?

For a read-only getter with six optional parameters and no output schema, the description gives the general purpose and contents but omits whether one of caseStudyId/researchRunId is expected, limit defaults, and the meaning of the boolean flags. Adequate but with clear gaps.

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 17%, so the description must compensate, but it only loosely maps to caseStudyId/researchRunId and says nothing about limit or the include* flags. The schema's own description covers only includeCandidateScriptSource.

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?

States a specific verb ('Return') and a distinct resource ('Algo Agent research notebook'), and enumerates contents (journal records, evidence, maturity, lessons, recent run items). This clearly differentiates it from sibling getters like ata_get_research_plan or ata_get_research_task.

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?

Provides no when-to-use or when-not-to-use guidance and names no alternatives. It only says the notebook is 'for a case study or research run,' leaving an agent to infer when to call this versus the many related getter tools.

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.

Resources