Mcp ​
- Type
- Class
- Namespace
- craft\services
- Inherits
- craft\services\Mcp » yii\base\Component » yii\base\BaseObject
- Implements
- yii\base\Configurable
MCP services and plugin extension registries.
@since 5.12.0
Public Properties ​
| Property | Description |
|---|---|
| behaviors | \yii\base\Behavior<static>[] – List of behaviors attached to this component. |
| capabilityContainer | |
| capabilityRegistry | |
| checkRegistry | |
| elementAdapterRegistry | |
| oAuthResource | |
| settings | |
| tokenScopes | string[], null – The OAuth scopes granted to the access token that authenticated the current request, or null if no token authenticated it. |
capabilityContainer ​
- Default value
null- Access
- Read-only
capabilityRegistry ​
- Default value
null- Access
- Read-only
checkRegistry ​
- Default value
null- Access
- Read-only
elementAdapterRegistry ​
- Default value
null- Access
- Read-only
oAuthResource ​
- Default value
null- Access
- Read-only
settings ​
- Default value
null- Access
- Read-only
tokenScopes ​
The OAuth scopes granted to the access token that authenticated the current request, or null if no token authenticated it.
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() | Constructor. |
| __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. |
| attachBehavior() | Attaches a behavior to this component. |
| attachBehaviors() | Attaches a list of behaviors to the component. |
| 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. |
| detachBehavior() | Detaches a behavior from the component. |
| detachBehaviors() | Detaches all behaviors from the component. |
| ensureBehaviors() | Makes sure that the behaviors declared in behaviors() are attached to this component. |
| getBehavior() | Returns the named behavior object. |
| getBehaviors() | Returns all behaviors attached to this component. |
| getCapabilityContainer() | |
| getCapabilityRegistry() | |
| getCheckRegistry() | |
| getElementAdapterRegistry() | |
| getOAuthResource() | Returns MCP's protected OAuth resource definition. |
| getSettings() | |
| 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. |
| off() | Detaches an existing event handler from this component. |
| on() | Attaches an event handler to an event. |
| resetSettings() | |
| trigger() | Triggers an event. |
getCapabilityContainer() ​
getCapabilityRegistry() ​
getCheckRegistry() ​
getElementAdapterRegistry() ​
getOAuthResource() ​
Returns MCP's protected OAuth resource definition.
@since 5.12.0
getSettings() ​
resetSettings() ​
Constants ​
| Constant | Description |
|---|---|
SCOPE_ADMIN | |
SCOPE_READ | |
SCOPE_WRITE |
Events ​
EVENT_DISCOVERING_CAPABILITY ​
- Type
- craft\mcp\events\DiscoveringCapability
- Since
- 5.12.0
The event that is triggered for each capability the authenticated or stdio server would expose to the current user. Set $event->allowed = false to hide it.
EVENT_REGISTER_CAPABILITY_TYPES ​
- Type
- craft\events\RegisterComponentTypesEvent
- Since
- 5.12.0
Registers SDK-attributed MCP capability classes.