> For the complete documentation index, see [llms.txt](https://docs.mozilla.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.mozilla.ai/mcpd/reference/makefile.md). # Makefile The `mcpd` project includes a `Makefile` to streamline common developer tasks. {% hint style="warning" %} **Running make** All commands should be run from the **root of the repository**. {% endhint %} *** ## Commands {% hint style="info" %} **Environment** Most commands assume you have Go installed and available in your `PATH`. {% endhint %} ### ๐Ÿงฑ Build * **Build the binary** ```bash make build ```

Architectures and Operating Systems

You can explicitly build the binary for a different architecture (amd64/arm64) or operating systems with:

* **Remove the compiled binary from the working directory** ```bash make clean ``` * **Install the binary to your system (typically `/usr/local/bin`)** ```bash sudo make install ```

Dependency

The install target relies on the standard build target.

* **Uninstall the binary** ```bash sudo make uninstall ``` *** ### ๐Ÿงช Test * **Run all Go tests** ```bash make test ``` *** ### โœ… Validation * **Run linter with auto-fix** ```bash make lint ``` * **Validate Mozilla AI registry against JSON schema** ```bash make validate-registry ```

When to use

Run this command before submitting PRs that modify:

*** ### ๐Ÿ“œ License and Attribution * **Check dependency licenses** ```bash make check-licenses ```

Allowed licenses

This validates that all dependencies use one of: Apache-2.0, MIT, BSD-2-Clause, BSD-3-Clause, ZeroBSD, or Unlicense.

* **Check NOTICE file is up to date** ```bash make check-notice ``` * **Generate NOTICE file** ```bash make notice ```

Third-party attribution

Regenerates the NOTICE file with current dependency license information.

*** ### ๐Ÿณ Run * **Start `mcpd` in a container** ```bash make local-up ```

Default files

By default the following files will be mounted to the container:

* **Stop mcpd** ```bash make local-down ``` *** ### ๐Ÿ“ Documentation These commands build the [GitBook](https://docs.mozilla.ai/mcpd) documentation site for `mcpd`. {% hint style="info" %} **Environment** Docs commands assume you have `uv` installed and available in your `PATH` (in addition to Go). {% endhint %} * **Generate CLI reference docs from the Cobra commands** ```bash make docs-cli ``` * **Generate the OpenAPI specification** ```bash make docs-api ``` * **Build the GitBook site into `site/` (runs the generators first)** ```bash make docs ```

Previewing

GitBook renders the published site from the gitbook-docs branch, so there is no local dev server. make docs assembles the publishable Markdown into site/ for inspection.

*** ## ๐Ÿงญ Target Reference Here's a complete list of Makefile targets: | Target | Description | | ------------------- | -------------------------------------------------------- | | `build` | Compile the Go binary | | `build-dev` | Compile the Go binary for development (no optimizations) | | `build-linux` | Compile the Go binary for Linux on amd64 | | `build-linux-arm64` | Compile the Go binary for Linux on arm64 | | `check-licenses` | Validate all dependency licenses are allowed | | `check-notice` | Verify NOTICE file is up to date | | `clean` | Remove compiled binary from working directory | | `docs` | Build the GitBook documentation site into `site/` | | `docs-api` | Generate the OpenAPI specification | | `docs-cli` | Generate CLI reference docs from the Cobra commands | | `install` | Install binary to system path | | `lint` | Run linter with auto-fix (includes check-notice) | | `local-down` | Stop a running `mcpd` Docker container | | `local-up` | Start `mcpd` in a Docker container | | `notice` | Generate NOTICE file with dependency licenses | | `test` | Run all Go tests (includes lint) | | `uninstall` | Remove installed binary | | `validate-registry` | Validate Mozilla AI registry JSON schema | --- # 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.mozilla.ai/mcpd/reference/makefile.md?ask=&goal= ``` `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.