> For the complete documentation index, see [llms.txt](https://quickserve.quintindev.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://quickserve.quintindev.com/creating-modules/service.md).

# Service

The entry point for your module

All QuickServe modules have a core class named `Service`. When QuickServe loads your module, it will instantiate this class.

### Contract

Modules in QuickServe must satisfy a "contract". The current requirements to satisfy the contract are the following:

#### Module (Class) Attributes:

Class Attributes,  also known as Module Attributes, that are required.

***

`NAME` - The internal name of your module. [Related Guidelines](/contributing/contribution-guidelines.md#module-name)

```python
NAME: str = "my-module-name
```

***

`VERSION` - The version of your module. [Related Guidelines](/contributing/contribution-guidelines.md#module-version)

```python
VERSION: str = "1.0.0"
```

***

`QUICKSERVE_VERSION` - The minimum version of QuickServe supported by your module.

```python
QUICKSERVE_VERSION: str = "0.0.1"
```

***

`PAGES` - A list of registered pages within your module.

```python
PAGES: list[str] = ["about", "create", "start", "filesystem"]
```

#### Module (Class) Methods

Class Methods,  also known as Module Methods, that are required.

{% hint style="info" %}

```python
PageResult: TypeAlias = str | tuple[str, dict[str, Any]]
```

{% endhint %}

***

`about` - The method that renders your module's about page.

```python
def about(self, *args: Any, **kwargs: Any) -> PageResult: ...
```

***

`create` - The method that creates an instance of your module.

```python
def create(self, *args: Any, **kwargs: Any) -> PageResult: ...
```


---

# 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://quickserve.quintindev.com/creating-modules/service.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.