> 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/2-6-1/connectors/custom-connectors/using-custom-connectors.md).

# Using Custom Connectors

Integrate custom connectors into Connectware services via service commissioning files and develop your data model on the MQTT broker.

You can use your custom connectors via service commissioning files, just like you use agents.

## Code Example of a Service Commissioning File Template

In this example, you establish the connection via the agent and use the endpoints to fill in the required parameters for the corresponding protocol. Make sure that the agent name matches the agent name that you have specified in the `docker-compose.yml` file in the [Deploying Custom Connectors](/2-6-1/connectors/custom-connectors/deploying-custom-connectors.md) topic.

Now, you can develop your data model on the MQTT broker in Connectware like any other service, for example, via mappings.

{% code lineNumbers="true" %}

```yaml
parameters:
  agentName:
    type: string
    description: Agent Name
    default: custom-connectware-agent # make sure it matches CYBUS_AGENT_NAME

resources:
  customConnection:
    type: Cybus::Connection
    properties:
      protocol: custom-protocol
      agentName: !ref agentName
      connection:
        host: localhost
        port: 50001

  ReadStatus:
    type: Cybus::Endpoint
    properties:
      protocol: custom-connector
      connection: !ref customConnection
      subscribe:
        function: read_status
        interval: 1000
```

{% 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/2-6-1/connectors/custom-connectors/using-custom-connectors.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.