> For the complete documentation index, see [llms.txt](https://docs.mikopbx.com/mikopbx-development/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.mikopbx.com/mikopbx-development/module-developement.md).

# Modules developement

- [How to start](https://docs.mikopbx.com/mikopbx-development/module-developement/template-module-structure.md): Clone the module template and prepare it for development.
- [Module anatomy](https://docs.mikopbx.com/mikopbx-development/module-developement/module-anatomy.md): The complete directory and file map of a MikoPBX module — every folder, the class it holds, and how the App / Lib / Worker tiers fit together.
- [module.json reference](https://docs.mikopbx.com/mikopbx-development/module-developement/module-json.md): Field reference for the module.json manifest, version constraints, and how dependencies actually work in MikoPBX.
- [Data model](https://docs.mikopbx.com/mikopbx-development/module-developement/data-model.md): Phalcon 5 models, table conventions, relationships and metadata in a MikoPBX module.
- [Module installer class](https://docs.mikopbx.com/mikopbx-development/module-developement/module-installer.md): The PbxExtensionSetup lifecycle: install, setup and uninstall an extension module.
- [Module main class](https://docs.mikopbx.com/mikopbx-development/module-developement/module-class.md): The ConfigClass-based hub: features, hooks, REST API methods, and PBX core interaction.
- [Hooks reference](https://docs.mikopbx.com/mikopbx-development/module-developement/hooks-reference.md): The complete verified catalog of MikoPBX module extension points (hooks): exact signatures, the interface that declares each constant, and the Core call site that fires them.
- [Recipes](https://docs.mikopbx.com/mikopbx-development/module-developement/recipes.md): Capability building blocks: the recipes that compose a MikoPBX module.
- [Workers and background processes](https://docs.mikopbx.com/mikopbx-development/module-developement/workers.md): Long-running background workers: Beanstalk and AMI patterns, registration and supervision via WorkerSafeScriptsCore.
- [Module interface](https://docs.mikopbx.com/mikopbx-development/module-developement/module-interface-empty.md): Building the admin-cabinet UI: controllers, forms, Volt views, providers and JS/CSS.
- [REST API in modules](https://docs.mikopbx.com/mikopbx-development/module-developement/rest-api-in-modules.md): Exposing a module REST API: the modern v3 attribute-routed pattern with auto-discovered #\[ApiResource] controllers, Processor + Action classes, and a DataStructure single source of truth that drives O
- [Translations](https://docs.mikopbx.com/mikopbx-development/module-developement/translations.md): Module localization: Messages files and the 29-language translation workflow.
- [Best practices](https://docs.mikopbx.com/mikopbx-development/module-developement/best-practices.md): Conventions, PHP 8.4 idioms, and anti-patterns to avoid when building MikoPBX modules.
- [Debuging](https://docs.mikopbx.com/mikopbx-development/module-developement/debuging.md)
- [Configuring IDE](https://docs.mikopbx.com/mikopbx-development/module-developement/debuging/configuring-ide.md)
- [Debug PHP-AGI](https://docs.mikopbx.com/mikopbx-development/module-developement/debuging/debug-php-agi.md)
- [Debug PHP Worker](https://docs.mikopbx.com/mikopbx-development/module-developement/debuging/debug-php-worker.md)
- [Debug PHP Script](https://docs.mikopbx.com/mikopbx-development/module-developement/debuging/debug-php-script.md)
- [Debugging behind NAT](https://docs.mikopbx.com/mikopbx-development/module-developement/debuging/debugging-behind-nat.md)


---

# 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.mikopbx.com/mikopbx-development/module-developement.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.