> For the complete documentation index, see [llms.txt](https://docs.lithnet.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.lithnet.io/ecma2-framework/v2.0/using-the-framework/defining-the-schema.md).

# Definining the schema

To define the schema for your management agent, you need to create a new schema provider class that inherits from the `ISchemaProvider` interface. This class will be responsible for providing the schema definition.

Let's break down how the provided example works:

1. Inheriting from `ISchemaProvider`:

The `SchemaProvider` class implements the `ISchemaProvider` interface, which requires the implementation of the `GetMmsSchemaAsync` method. This method returns a `Task<Schema>` object representing the schema.

2. Defining the schema:

The `GetMmsSchemaAsync` method creates a new instance of the `Schema` class, which represents the entire schema for the management agent. It then adds a single schema type, "user", to the `Schema` object by calling the `GetSchemaTypeUser` method.

3. Defining schema attributes:

The `GetSchemaTypeUser` method creates a new instance of the `SchemaType` class, representing a specific type within the schema. In this case, the type is "user". It defines attributes such as "id", "name", "email", and "phone" using the appropriate methods.

4. Returning the schema:

Once the schema is defined, the `GetMmsSchemaAsync` method returns the `Schema` object wrapped in a completed `Task` using the `Task.FromResult` method.

In summary, the `SchemaProvider` class defines a schema for a data model by creating a `Schema` object, adding a "user" type with specific attributes, and returning the schema through the `GetMmsSchemaAsync` method. This allows other components of the application to access and utilize the defined schema for various purposes, such as data import and export.

````cs
using System.Threading.Tasks;
using Microsoft.MetadirectoryServices;

namespace Lithnet.Ecma2Framework.Example
{
   internal class SchemaProvider : ISchemaProvider
   {
       public Task<Schema> GetMmsSchemaAsync()
       {
           Schema mmsSchema = new Schema();
           mmsSchema.Types.Add(this.GetSchemaTypeUser());

           return Task.FromResult(mmsSchema);
       }

       private SchemaType GetSchemaTypeUser()
       {
           SchemaType mmsType = SchemaType.Create("user", true);
           SchemaAttribute mmsAttribute = SchemaAttribute.CreateAnchorAttribute("id", AttributeType.String, AttributeOperation.ImportOnly);
           mmsType.Attributes.Add(mmsAttribute);

           mmsAttribute = SchemaAttribute.CreateSingleValuedAttribute("name", AttributeType.String, AttributeOperation.ImportExport);
           mmsType.Attributes.Add(mmsAttribute);

           mmsAttribute = SchemaAttribute.CreateSingleValuedAttribute("email", AttributeType.String, AttributeOperation.ImportExport);
           mmsType.Attributes.Add(mmsAttribute);

           mmsAttribute = SchemaAttribute.CreateSingleValuedAttribute("phone", AttributeType.String, AttributeOperation.ImportExport);
           mmsType.Attributes.Add(mmsAttribute);

           return mmsType;
       }
   }
}

## Configuration parameters
You can get the configuration parameters set for the management agent, by injecting `IConfigParameters` into your classes constructor.


```cs
using System.Threading.Tasks;
using Microsoft.MetadirectoryServices;

namespace Lithnet.Ecma2Framework.Example
{
   internal class SchemaProvider : ISchemaProvider
   {
       private readonly IConfigurationParameters configParameters;

       public SchemaProvider(IConfigurationParameters configParameters)
       {
           this.configParameters = configParameters;
       }

       // Class implementation
   }
}
````

If you are using the `Options<T>` pattern for configuration, then simply inject the relevant strongly-typed options objects into your class.

```cs
using System.Threading.Tasks;
using Microsoft.MetadirectoryServices;

namespace Lithnet.Ecma2Framework.Example
{
   internal class SchemaProvider : ISchemaProvider
   {
       private readonly SchemaOptions schemaOptions;

       public SchemaProvider(IOptions<SchemaOptions> schemaOptions)
       {
           this.schemaOptions = schemaOptions.Value;
       }

       // Class implementation
   }
}
```


---

# 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.lithnet.io/ecma2-framework/v2.0/using-the-framework/defining-the-schema.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.
