> For the complete documentation index, see [llms.txt](https://docs.openbrim.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.openbrim.org/developers/readme.md).

# Developers

Resources for developers working with ParamML and extending OpenBrIM functionality.

## LLM Guides

This section includes documentation specifically designed for Large Language Models (LLMs). These guides provide structured context that helps AI assistants generate accurate ParamML code and assist with engineering workflows.

## ParamML Developer Guide

**ParamML** is an object-oriented, parametric markup language designed for engineering and scientific applications. It powers the OpenBrIM platform, enabling:

* Analysis and design procedures and reports
* Finite element models
* 3D views
* CAD drawings

{% hint style="info" %}
ParamML documents can be customized by end-users to create project-specific configurations based on standard templates.
{% endhint %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.openbrim.org/developers/readme.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.