GetNinjaScriptHelp
Returns NinjaScript-style help text for a topic or symbol. Pair with SearchNinjaScriptSymbols and LookupNinjaScriptSymbol to ground AI-generated NinjaScript in real NT8 signatures.
| Property | Value |
|---|---|
| Required scope | mcp:read |
| Risk | None. Read-only. |
| Side effects | None. |
When an agent should use it
- Before generating NinjaScript for an indicator or method the model is unsure of.
- During compile-error repair when the diagnostic points to a missing method or wrong overload.
When an agent should not use it
- For prose documentation. This tool returns API-style help, not tutorials.
Parameters
{ "topic": "EMA" }
Response shape
{
"topic": "EMA",
"summary": "Exponential moving average. Multi-overload helper resolved against NT8 indicators.",
"members": [
{"name": "EMA(int period)", "returns": "EMA"},
{"name": "EMA(ISeries<double> input, int period)", "returns": "EMA"}
]
}
Example user prompt
Before writing the strategy, call GetNinjaScriptHelp on EMA, ATR, and CrossAbove.
Restate the signatures you plan to use and confirm they exist in this install.
Common errors
| Symptom | Likely cause | Fix |
|---|---|---|
topic_not_found | Typo or non-existent symbol. | Try SearchNinjaScriptSymbols for fuzzy matching. |
Use in AI-generated NinjaScript workflows
- When the agent should call it: before writing any line of NinjaScript that references an NT8 type or method the model is unsure of, and on every unresolved identifier after a compile failure.
- Required scope:
mcp:read. - Confirmation required: no. This is a read tool with no side effects.
- What the agent should summarize: the signature(s) chosen for the strategy, plus any alternatives that were considered and rejected.
- Failure mode it helps catch: invented or stale method overloads. The model's training data may not match the running NT8 surface; this tool surfaces the real one.
For the broader vibe coding workflow, see NinjaScript AI Workflow.