Skip to content

Enhance documentation consistency and Tool class annotations #57

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
merged 3 commits into from
Sep 21, 2025
Merged

Enhance documentation consistency and Tool class annotations #57

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e691a87
use nowdoc for instructions and fix changelog URLs
Sep 20, 2025
24c785b
Add missing @return docblock for Tool::toArray() method
Sep 21, 2025
b43cfe1
Improve Tool::toArray() return type annotation
Sep 21, 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
4 changes: 2 additions & 2 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Release Notes

## [Unreleased](https://github.com/laravel/package-template/compare/v0.2.0...main)
## [Unreleased](https://github.com/laravel/mcp/compare/v0.2.0...main)

## [v0.2.0](https://github.com/laravel/package-template/compare/v0.1.0...v0.2.0) - 2025-09-18
## [v0.2.0](https://github.com/laravel/mcp/compare/v0.1.0...v0.2.0) - 2025-09-18

- First official "beta" release of Laravel MCP package.

Expand Down
4 changes: 3 additions & 1 deletion src/Server.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,9 @@ abstract class Server

protected string $version = '0.0.1';

protected string $instructions = 'This MCP server lets AI agents interact with our Laravel application.';
protected string $instructions = <<<'MARKDOWN'
This MCP server lets AI agents interact with our Laravel application.
MARKDOWN;

/**
* @var array<int, string>
Expand Down
11 changes: 11 additions & 0 deletions src/Server/Tool.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,17 @@ public function toMethodCall(): array
return ['name' => $this->name()];
}

/**
* Get the tool's array representation.
*
* @return array{
* name: string,
* title?: string|null,
* description?: string|null,
* inputSchema?: array<string, mixed>,
* annotations?: array<string, mixed>|object
* }
*/
public function toArray(): array
{
$annotations = $this->annotations();
Expand Down
Loading