AGENTS.md¶
This page is written for autonomous coding agents (LLMs, retrieval agents, or developer tools that ground answers in this site). Humans are welcome too, but it's terser than the rest of the documentation by design.
Three places to look¶
| You want... | Fetch |
|---|---|
| A topical answer or a working snippet | /**/*.md (markdown source) |
| The exact signature, parameter, return type of a member | /api-md/<full-uid>.md |
| A machine-friendly index of every page | /llms.txt |
| All pages concatenated into one document | /llms-full.txt |
URL conventions¶
- Every public type maps to
/api-md/<full-uid>.md. Example:SIDRASolutions.SI.API.ISIAPILaneMovement→/api-md/sidrasolutions.si.api.isiapilanemovement.md. UIDs are lowercased; no other transformation. - Members live in the same file as their owning type, not on separate
pages. Use anchor links:
/api-md/sidrasolutions.si.api.isiapi.md#openproject. - Every markdown file has YAML frontmatter with
uid,type,namespace, andsummary— parse these before reading prose.
What the API actually is¶
- A .NET 8 COM-visible assembly:
SIDRASolutions.SI.API. - Root activation interface:
ISIAPI(Type.GetTypeFromProgID("SIDRASolutions.SI.API")). - Object model is tree-shaped:
Project → Site → Intersection → Leg → LaneMovement. - See Object model for the full hierarchy
and naming conventions (
I...singular,I...splural,..._<variant>for parameter-set variants,...MCfor movement-class-specific types). - x64 only. STA threading required.
Heuristics for retrieval¶
- "How do I do X?" → start with
/getting-started.mdand/samples/csharp.md. - "What does method/property X do?" → find the owning type in
/api-md/. - "How are sites and networks related?" →
/concepts/object-model.md. - "Activation fails with HRESULT 0x...?" →
/com-activation.md#troubleshooting.
What is not on this site¶
- Behavioural specifics of the traffic-engineering models (HCM, roundabout capacity, gap acceptance). The API exposes inputs and outputs; the modelling itself is documented in the SIDRA Intersection User Guide, shipped with the product.
- Licensing, install, and activation of SIDRA Intersection itself. See the product's installer and licence portal.