> For the complete documentation index, see [llms.txt](https://boxlang-ide.ortusbooks.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://boxlang-ide.ortusbooks.com/vscode/miniserver.md).

# MiniServer

The BoxLang MiniServer is a fast and convenient way to run a BoxLang web server. It is very powerful and integrates directly with VSCode.

This page primarily covers features specific to the VSCode extensions use of the MiniServer. To learn more about the MiniServer itself and other ways to use it refer to the [official MiniServer documentation](https://boxlang.ortusbooks.com/getting-started/running-boxlang/miniserver).

The MIniServer

* Is an undertow based ultralight web server
* Configurable through the VSCode UI
* Allows line debugging with the click of a button

### Creating a Server

You can create a MiniServer through the BoxLang panel and clicking "Create MiniServer" or using the "+" icon to the top right of the MiniServer panel.

<figure><img src="https://1233156051-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FCTmMyQRBKdwlMEIQiYzM%2Fuploads%2FtFmhm9bLE6FOoXh5uqFw%2FScreenshot%202025-04-29%20at%201.28.11%E2%80%AFAM.png?alt=media&amp;token=646e2c20-9345-437c-a087-6f572d8f1bfc" alt="" width="264"><figcaption></figcaption></figure>

Once you start creating a server you will be shown a series of prompts that allow you to name and configure different server properties.

### Managing a MiniServer

Once created MiniServers will appear in the panel and provide you with several options for managing their settings and interacting with them.

<figure><img src="https://1233156051-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FCTmMyQRBKdwlMEIQiYzM%2Fuploads%2FI3LXQ167071D670PAtPF%2Fimage.png?alt=media&amp;token=e88c6c3e-d256-46e2-95bf-bbf29c9b8a7b" alt="" width="264"><figcaption></figcaption></figure>

Some of the properties can be edited by hovering over them and clicking the pencil icon.\
\
In addition to being able to edit the server properties you can press the "play"  button to start the server.

### Running a Server

Once you have started a MiniServer your action items will change. You will gain new actions like

* Stop - shutdown the MiniServer
* Debug - start a debug session in VSCode and attach to the MiniServer
* Open - open the browser to the root of the server


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://boxlang-ide.ortusbooks.com/vscode/miniserver.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.
