Skip to content

Add documentation for explicitly setting tool annotation values #10956

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
taylorotwell merged 3 commits into from
Dec 19, 2025
Merged

Add documentation for explicitly setting tool annotation values #10956

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
911593e
Add documentation for explicitly setting tool annotation values
soleinjast Dec 19, 2025
ab2141c
docs: document explicit boolean values for tool annotations
soleinjast Dec 19, 2025
394652b
Remove annotation values section from mcp.md
taylorotwell Dec 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 30 additions & 1 deletion mcp.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -494,6 +494,35 @@ Available annotations include:
| `#[IsIdempotent]` | boolean | Indicates repeated calls with same arguments have no additional effect (when not read-only). |
| `#[IsOpenWorld]` | boolean | Indicates the tool may interact with external entities. |

> [!NOTE]
> Tool annotations are optional, but omitted annotations are assigned **default values**
> as defined by the MCP specification.
>
> This means that not specifying an annotation does **not** imply `false`.
> For example, omitting `#[IsDestructive]` does not guarantee that a tool
> will be treated as non-destructive during MCP inspection.

#### Explicitly Setting Annotation Values

To avoid ambiguity—especially during automated MCP inspection or OpenAI app review—
it is recommended to explicitly define annotation values:

```php
use Laravel\Mcp\Server\Tools\Annotations\IsReadOnly;
use Laravel\Mcp\Server\Tools\Annotations\IsDestructive;
use Laravel\Mcp\Server\Tools\Annotations\IsOpenWorld;
use Laravel\Mcp\Server\Tools\Annotations\IsIdempotent;
use Laravel\Mcp\Server\Tool;

#[IsReadOnly(true)]
#[IsDestructive(false)]
#[IsOpenWorld(false)]
#[IsIdempotent(true)]
class CurrentWeatherTool extends Tool
{
//
}
```
<a name="conditional-tool-registration"></a>
### Conditional Tool Registration

Expand Down Expand Up @@ -1622,4 +1651,4 @@ Finally, if you wish to inspect the raw response content, you may use the `dd` o
```php
$response->dd();
$response->dump();
```
```