Skip to content

Address #179 so example in README.md will run #189

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

Open
jwoehr wants to merge 1 commit into
base: main
Choose a base branch
from
+15 −4
Open

Address #179 so example in README.md will run #189

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
19 changes: 15 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ and clients in PHP.
> [!IMPORTANT]
> This SDK is currently in active development with ongoing refinement of its architecture and features. While
> functional, the API may experience changes as we work toward stabilization.
>
>
> If you want to help us stabilize the SDK, please see the [issue tracker](https://github.com/modelcontextprotocol/php-sdk/issues).

This project represents a collaboration between [the PHP Foundation](https://thephp.foundation/) and the [Symfony project](https://symfony.com/). It adopts
Expand All @@ -18,6 +18,7 @@ Until the first major release, this SDK is considered [experimental](https://sym
## Roadmap

**Features**

- [ ] Stabilize server component with all needed handlers and functional tests
- [ ] Extend documentation, including integration guides for popular frameworks
- [ ] Implement Client component
Expand Down Expand Up @@ -47,6 +48,11 @@ use Mcp\Capability\Attribute\McpResource;

class CalculatorElements
{
/**
* Class must be constructable through the container
*/
public function __construct() {}

/**
* Adds two numbers together.
*
Expand Down Expand Up @@ -173,12 +179,14 @@ $server = Server::builder()
### Multiple Transport Options

**STDIO Transport** (Command-line integration):

```php
$transport = new StdioTransport();
$server->run($transport);
```

**HTTP Transport** (Web-based communication):

```php
$transport = new StreamableHttpTransport($request, $responseFactory, $streamFactory);
$response = $server->run($transport);
Expand Down Expand Up @@ -251,24 +259,27 @@ $server = Server::builder()
## Documentation

**Core Concepts:**

- [Server Builder](docs/server-builder.md) - Complete ServerBuilder reference and configuration
- [Transports](docs/transports.md) - STDIO and HTTP transport setup and usage
- [MCP Elements](docs/mcp-elements.md) - Creating tools, resources, and prompts
- [Client Communication](docs/client-communication.md) - Communicating back to the client from server-side

**Learning:**

- [Examples](docs/examples.md) - Comprehensive example walkthroughs

**External Resources:**

- [Model Context Protocol documentation](https://modelcontextprotocol.io)
- [Model Context Protocol specification](https://spec.modelcontextprotocol.io)
- [Officially supported servers](https://github.com/modelcontextprotocol/servers)

## PHP Libraries Using the MCP SDK

* [pronskiy/mcp](https://github.com/pronskiy/mcp) - Additional DX layer
* [symfony/mcp-bundle](https://github.com/symfony/mcp-bundle) - Symfony integration bundle
* [josbeir/cakephp-synapse](https://github.com/josbeir/cakephp-synapse) - CakePHP integration plugin
- [pronskiy/mcp](https://github.com/pronskiy/mcp) - Additional DX layer
- [symfony/mcp-bundle](https://github.com/symfony/mcp-bundle) - Symfony integration bundle
- [josbeir/cakephp-synapse](https://github.com/josbeir/cakephp-synapse) - CakePHP integration plugin

## Contributing

Expand Down