> For the complete documentation index, see [llms.txt](https://docs.cybus.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.cybus.io/data-flows/service-commissioning-files/metadata.md).

# Metadata

Give your service a name and, optionally, a version, a provider, a homepage, and an icon.

The metadata section holds the properties that identify your service, such as its name and version. Only [name](#name) is required. The metadata travels with the service commissioning file, so your service stays recognizable wherever you install or store it.

* **Required**
* Type: `object`

## Metadata Properties

| Property              | Type     | Required     |
| --------------------- | -------- | ------------ |
| [name](#name)         | `string` | **Required** |
| [homepage](#homepage) | `string` | Optional     |
| [icon](#icon)         | `string` | Optional     |
| [provider](#provider) | `string` | Optional     |
| [version](#version)   | `string` | Optional     |

### name

A short title for the service, which the Admin UI shows in the [Service Overview](https://docs.cybus.io/data-flows/services/service-overview.md).

Connectware derives the default [service ID](https://docs.cybus.io/data-flows/services/serviceid.md#default-service-id) from the name. It converts the name to lowercase and keeps only the letters `a` to `z` and the digits `0` to `9`, so `Simulated Machining Center` becomes `simulatedmachiningcenter`.

You can use [parameter substitution](https://docs.cybus.io/data-flows/service-commissioning-files/parameters.md#string-substitution-method-sub) in the name. For example, with a parameter named `machineNum`, write `!sub 'Machine ${machineNum}'`.

* **Required**
* Type: `string`
* Maximum length: 80 characters

### homepage

The URL of the provider's homepage.

* **Optional**
* Type: `string`
* Format: `uri`, a Uniform Resource Identifier as defined in [RFC 3986](https://www.rfc-editor.org/rfc/rfc3986)

### icon

A link to an icon image for the service. The Admin UI shows the icon in the header of the [Service Details](https://docs.cybus.io/data-flows/services/service-details-view.md) view.

* **Optional**
* Type: `string`

### provider

The provider or author of the service commissioning file.

* **Optional**
* Type: `string`

### version

A version number for the service. Connectware accepts any string, so use whichever scheme suits you, such as a semantic version, and raise it as you revise your service commissioning file. Quote a value that YAML reads as a number, such as `'1.0'` or `'2'`.

Connectware shows this value in the **Version** column of the [Service Overview](https://docs.cybus.io/data-flows/services/service-overview.md).

This property is unrelated to the [version](https://docs.cybus.io/data-flows/service-commissioning-files/version.md) section, which declares the format of the service commissioning file itself.

{% code lineNumbers="true" %}

```yaml
metadata:
  name: Simulated Machining Center
  version: 1.0.0
```

{% endcode %}

* **Optional**
* Type: `string`

## Example

{% code lineNumbers="true" %}

```yaml
metadata:
  name: Simulated Machining Center
  version: 1.0.0
  icon: https://example.com/machine-icon.svg
  provider: cybus
  homepage: https://www.cybus.io
```

{% endcode %}


---

# 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://docs.cybus.io/data-flows/service-commissioning-files/metadata.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.
