> 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="/files/O8SwLCtfR676CzPDMAuS" 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="/files/UHSnvCCWt7XwZunfpyHh" 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 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://boxlang-ide.ortusbooks.com/vscode/miniserver.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.