CollectingServerInstructions ​
- Type
- Class
- Namespace
- craft\mcp\events
- Inherits
- craft\mcp\events\CollectingServerInstructions » yii\base\Event » yii\base\BaseObject
- Implements
- yii\base\Configurable
- Since
- 5.12.0
Lets plugins add to the instructions the authenticated and stdio MCP servers send every client when it connects.
Keep additions short. Every user receives them, including users without control panel access.
Public Properties ​
| Property | Description |
|---|---|
| data | mixed – The data that is passed to yii\base\Component::on() when attaching an event handler. |
| handled | boolean – Whether the event is handled. |
| instructions | string[] |
| name | string – The event name. |
| sender | object, null – The sender of this event. |
instructions ​
- Type
- string[]
- Default value
[]
Public Methods ​
| Method | Description |
|---|---|
| __call() | Calls the named method which is not a class method. |
| __construct() | Constructor. |
| __get() | Returns the value of an object property. |
| __isset() | Checks if a property is set, i.e. defined and not null. |
| __set() | Sets value of an object property. |
| __unset() | Sets an object property to null. |
| 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. |
| hasHandlers() | Returns a value indicating whether there is any handler attached to the specified class-level event. |
| hasMethod() | Returns a value indicating whether a method is defined. |
| hasProperty() | Returns a value indicating whether a property is defined. |
| init() | Initializes the object. |
| off() | Detaches an event handler from a class-level event. |
| offAll() | Detaches all registered class-level event handlers. |
| on() | Attaches an event handler to a class-level event. |
| trigger() | Triggers a class-level event. |