Settings

Type

Class

Namespace

craft\mcp

Inherits

craft\mcp\Settings » craft\base\Model » yii\base\Model » yii\base\Component » yii\base\BaseObject

Implements

ArrayAccess, IteratorAggregate, craft\base\ModelInterface, yii\base\Arrayable, yii\base\Configurable, yii\base\StaticInstanceInterface

Uses traits

craft\base\ClonefixTrait, yii\base\ArrayableTrait, yii\base\StaticInstanceTrait

MCP server settings and public approvals, stored in project config.

@since 5.12.0

View source

Public Properties

Property	Description
activeValidators	yii\validators\Validator – The validators applicable to the current scenario.
attributes	array<string,mixed> – Attribute values (name => value).
authorizationRoute	– The app-relative path that always requires authentication, so OAuth clients can discover it.
behaviors	\yii\base\Behavior<static>[] – List of behaviors attached to this component.
enabled	– Whether the authenticated MCP server is enabled.
errors	array – Errors for all attributes.
firstErrors	array<string,string> – The first errors.
iterator	\ArrayIterator<string,mixed> – An iterator for traversing the items in the list.
publicAllowDrafts
publicAllowInactive
publicAllowRevisions
publicElementTypes
publicEnabled
publicNestedEntryFieldHandles
publicPrompts
publicResourceTemplates
publicResources
publicRoute
publicSectionHandles
publicSiteHandles
publicTools
publicUserGroupHandles
publicVolumeHandles
route	– The authenticated MCP server's app-relative path.
scenario	string – The scenario that this model is in.
validators	\ArrayObject<int,\yii\validators\Validator>, yii\validators\Validator – All the validators declared in the model.

authorizationRoute

Default value

'/mcp/auth'

View source

enabled

Default value

false

View source

publicAllowDrafts

Default value

false

View source

publicAllowInactive

Default value

false

View source

publicAllowRevisions

Default value

false

View source

publicElementTypes

Default value

[]

View source

publicEnabled

Default value

false

View source

publicNestedEntryFieldHandles

Default value

[]

View source

publicPrompts

Default value

[]

View source

publicResourceTemplates

Default value

[]

View source

publicResources

Default value

[]

View source

publicRoute

Default value

'/mcp'

View source

publicSectionHandles

Default value

[]

View source

publicSiteHandles

Default value

[]

View source

publicTools

Default value

[]

View source

publicUserGroupHandles

Default value

[]

View source

publicVolumeHandles

Default value

[]

View source

route

Default value

'/mcp'

View source

Public Methods

Method	Description
__call()	Calls the named method which is not a class method.
__clone()	This method is called after the object is created by cloning an existing one.
__construct()
__get()	Returns the value of a component property.
__isset()	Checks if a property is set, i.e. defined and not null.
__set()	Sets the value of a component property.
__unset()	Sets a component property to be null.
activeAttributes()	Returns the attribute names that are subject to validation in the current scenario.
addError()	Adds a new error to the specified attribute.
addErrors()	Adds a list of errors.
addModelErrors()	Adds errors from another model, with a given attribute name prefix.
afterValidate()	This method is invoked after validation ends.
attachBehavior()	Attaches a behavior to this component.
attachBehaviors()	Attaches a list of behaviors to the component.
attributeHints()	Returns the attribute hints.
attributeLabels()	Returns the attribute labels.
attributes()	Returns the list of attribute names.
beforeValidate()	This method is invoked before validation starts.
behaviors()	Returns a list of behaviors that this component should behave as.
canGetProperty()	Returns a value indicating whether a property can be read.
canSetProperty()	Returns a value indicating whether a property can be set.
className()	Returns the fully qualified name of this class.
clearErrors()	Removes errors for all attributes or a single attribute.
createValidators()	Creates validator objects based on the validation rules specified in rules().
datetimeAttributes()	Returns the names of any attributes that should hold DateTime values.
detachBehavior()	Detaches a behavior from the component.
detachBehaviors()	Detaches all behaviors from the component.
discoverableServers()	Returns the servers that /.well-known/ai-catalog.json advertises, as app-relative paths mapped to whether each is the public server.
ensureBehaviors()	Makes sure that the behaviors declared in behaviors() are attached to this component.
extraFields()	Returns the list of fields that can be expanded further and returned by toArray().
fields()	Returns the list of fields that should be returned by default by toArray() when no specific fields are specified.
formName()	Returns the form name that this model class should use.
generateAttributeLabel()	Generates a user friendly attribute label based on the give attribute name.
getActiveValidators()	Returns the validators applicable to the current scenario.
getAttributeHint()	Returns the text hint for the specified attribute.
getAttributeLabel()	Returns the text label for the specified attribute.
getAttributes()	Returns attribute values.
getBehavior()	Returns the named behavior object.
getBehaviors()	Returns all behaviors attached to this component.
getErrorSummary()	Returns the errors for all attributes as a one-dimensional array.
getErrors()
getFirstError()	Returns the first error of the specified attribute.
getFirstErrors()	Returns the first error of every attribute in the model.
getIterator()	Returns an iterator for traversing the attributes in the model.
getScenario()	Returns the scenario that this model is used in.
getValidators()	Returns all the validators declared in rules().
hasErrors()	Returns a value indicating whether there is any validation error.
hasEventHandlers()	Returns a value indicating whether there is any handler attached to the named event.
hasMethod()	Returns a value indicating whether a method is defined.
hasProperty()	Returns a value indicating whether a property is defined for this component.
init()	Initializes the object.
instance()	Returns static class instance, which can be used to obtain meta information.
isAttributeActive()	Returns a value indicating whether the attribute is active in the current scenario.
isAttributeRequired()	Returns a value indicating whether the attribute is required.
isAttributeSafe()	Returns a value indicating whether the attribute is safe for massive assignments.
isCpRoute()	Whether a route begins with the control panel trigger.
load()	Populates the model with input data.
loadMultiple()	Populates a set of models with the data from end user.
off()	Detaches an existing event handler from this component.
offsetExists()	Returns whether there is an element at the specified offset.
offsetGet()	Returns the element at the specified offset.
offsetSet()	Sets the element at the specified offset.
offsetUnset()	Sets the element value at the specified offset to null.
on()	Attaches an event handler to an event.
onUnsafeAttribute()	This method is invoked when an unsafe attribute is being massively assigned.
requestRoute()	Returns the route for a request to one of the enabled servers' paths, or false.
rules()	Returns the validation rules for attributes.
safeAttributes()	Returns the attribute names that are safe to be massively assigned in the current scenario.
scenarios()	Returns a list of scenarios and the corresponding active attributes.
setAttributes()	Sets the attribute values in a massive way.
setScenario()	Sets the scenario for the model.
toArray()	Converts the model into an array.
trigger()	Triggers an event.
url()	Returns the absolute URL for a route.
validate()	Performs the data validation.
validateMultiple()	Validates multiple models.
validateRoute()
validateScopes()

discoverableServers()

Returns the servers that /.well-known/ai-catalog.json advertises, as app-relative paths mapped to whether each is the public server.

Servers on control panel URLs are never advertised, and the authenticated server is only advertised when people can register for an account on the front end.

View source

isCpRoute()

Whether a route begins with the control panel trigger.

View source

Arguments

• $route

requestRoute()

Returns the route for a request to one of the enabled servers' paths, or false.

Requests to a path both servers share go to the authenticated server when they send credentials, or when a browser requests its setup page.

View source

Arguments

• $request

url()

Returns the absolute URL for a route.

View source

Arguments

• $route

validateRoute()

View source

Arguments

• $attribute

validateScopes()

View source

Arguments

• $attribute

Protected Methods

Method	Description
defineBehaviors()	Returns the behaviors to attach to this class.
defineRules()
extractFieldsFor()	Extract nested fields from a fields collection for a given root field Nested fields are separated with dots (.). e.g: "item.id" The previous example would extract "id".
extractRootFields()	Extracts the root field names from nested fields.
resolveFields()	Determines which fields can be returned by toArray().

defineRules()

View source

Constants

Constant	Description
SCENARIO_DEFAULT	The name of the default scenario.