Server Configuration
Describes the environment variables required to run the server.
| Name | Required | Description | Default |
|---|---|---|---|
| FOREMAN_URL | No | The URL of the Foreman server | https://$hostname |
| FOREMAN_PASSWORD | No | The password for Foreman authentication | changeme |
| FOREMAN_USERNAME | No | The username for Foreman authentication | admin |
Capabilities
Features and capabilities supported by this server
| Capability | Details |
|---|---|
| tools | {
"listChanged": true
} |
| prompts | {
"listChanged": false
} |
| resources | {
"subscribe": false,
"listChanged": false
} |
| experimental | {} |
Tools
Functions exposed to the LLM to take actions
| Name | Description |
|---|---|
| call_foreman_api | Call an action on a Foreman API resource. Needs Foreman API resource to be available. |
| fetch_foreman_dsl_docs | Fetches the DSL documentation from Foreman. |
| get_foreman_api_resource_docs | Fetches the documentation for given Foreman API resource. |
| Get Foreman DSL Documentation | Reads from cache and returns the documentation of available macros for template writing in Markdown format based on provided section. Refer to foreman://documentation/dsl/sections for available sections. |
Prompts
Interactive templates invoked by user choice
| Name | Description |
|---|---|
| Basic Subnets Static Report | A prompt for generating a static report of all subnets in Foreman. |
| Basic Hosts Pending Security Updates Static Report | A prompt for generating a static report of hosts with pending security updates in Foreman. |
| Basic Template Writing | A prompt for writing a basic template in Foreman |
Resources
Contextual data attached and managed by the client
| Name | Description |
|---|---|
| Foreman Resources | Provides a list of all resources available in the Foreman API. |
| Foreman API Resource | Checks if the Foreman API is available and can be used. |
| Foreman DSL Sections | Returns all Foreman DSL sections available for template writing. |
| Foreman Template Kinds | Provides a list of all template kinds available in Foreman. |
| Foreman Template Models | Provides a list of all template models available in Foreman. |
| Foreman Template Schema | Returns the schema of a Foreman template. |