Add API documentation generation with phpDocumentor

.github/workflows/docs.yml

@@ -0,0 +1,35 @@
+name: Deploy Documentation
+
+on:
+  release:
+    types: [published]
+  workflow_dispatch:
+
+permissions:
+  contents: write
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v5
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: '8.4'
+          coverage: "none"
+
+      - name: Install Composer
+        uses: "ramsey/composer-install@v3"
+
+      - name: Generate Documentation
+        run: make docs
+
+      - name: Deploy to gh-pages branch
+        uses: peaceiris/actions-gh-pages@v4
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./build/docs
+          enable_jekyll: false

.github/workflows/pipeline.yaml

@@ -132,3 +132,6 @@ jobs:
 
       - name: PHPStan
         run: vendor/bin/phpstan analyse
+
+      - name: Documentation
+        run: make docs

.gitignore

@@ -7,3 +7,8 @@ examples/**/dev.log
 examples/**/cache
 examples/**/sessions
 results
+
+# phpDocumentor
+build/
+.phpdoc/cache/
+phpDocumentor.phar

.phpdoc/template/base.html.twig

@@ -0,0 +1,8 @@
+{% extends 'layout.html.twig' %}
+
+{% set topMenu = {
+    "menu": [
+        { "name": "Guides", "url": "guide/docs/index.html"}
+    ]
+}
+%}

Makefile

@@ -1,4 +1,4 @@
-.PHONY: deps-stable deps-low cs phpstan tests unit-tests inspector-tests coverage ci ci-stable ci-lowest
+.PHONY: deps-stable deps-low cs phpstan tests unit-tests inspector-tests coverage ci ci-stable ci-lowest docs
 
 deps-stable:
 	composer update --prefer-stable
@@ -35,3 +35,8 @@ ci: ci-stable
 ci-stable: deps-stable cs phpstan tests
 
 ci-lowest: deps-low cs phpstan tests
+
+docs:
+	vendor/bin/phpdoc
+	@grep -q 'No errors have been found' build/docs/reports/errors.html || \
+		(echo "Documentation errors found. See build/docs/reports/errors.html" && exit 1)

composer.json

@@ -36,7 +36,9 @@
     "laminas/laminas-httphandlerrunner": "^2.12",
     "nyholm/psr7": "^1.8",
     "nyholm/psr7-server": "^1.1",
+    "phar-io/composer-distributor": "^1.0.2",
     "php-cs-fixer/shim": "^3.91",
+    "phpdocumentor/shim": "^3",
     "phpstan/phpstan": "^2.1",
     "phpunit/phpunit": "^10.5",
     "psr/simple-cache": "^2.0 || ^3.0",
@@ -69,7 +71,8 @@
   },
   "config": {
     "allow-plugins": {
-      "php-http/discovery": false
+      "php-http/discovery": false,
+      "phpdocumentor/shim": true
     },
     "sort-packages": true
   }

docs/index.md

@@ -0,0 +1,7 @@
+# MCP PHP SDK Guides
+
+- [MCP Elements](mcp-elements.html) — Core capabilities (Tools, Resources, Resource Templates, and Prompts) with registration methods.
+- [Server Builder](server-builder.html) — Fluent builder class for creating and configuring MCP server instances.
+- [Transports](transports.html) — STDIO and HTTP transport implementations with guidance on choosing between them.
+- [Client Communication](client-communication.html) — Methods for servers to communicate back to clients: sampling, logging, progress, and notifications.
+- [Examples](examples.html) — Example projects demonstrating attribute-based discovery, dependency injection, HTTP transport, and more.

phpdoc.dist.xml

@@ -0,0 +1,32 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<phpdocumentor
+    configVersion="3"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xmlns="https://www.phpdoc.org"
+    xsi:noNamespaceSchemaLocation="https://docs.phpdoc.org/latest/phpdoc.xsd"
+>
+    <title>MCP PHP SDK</title>
+    <paths>
+        <output>build/docs</output>
+    </paths>
+    <version number="latest">
+        <api>
+            <source dsn=".">
+                <path>src</path>
+            </source>
+            <output>api</output>
+            <ignore>
+                <path>vendor/**/*</path>
+                <path>tests/**/*</path>
+            </ignore>
+        </api>
+        <guide format="md">
+            <source dsn=".">
+                <path>docs</path>
+            </source>
+            <output>guide</output>
+        </guide>
+    </version>
+    <setting name="guides.enabled" value="true"/>
+    <setting name="graphs.enabled" value="true"/>
+</phpdocumentor>

src/JsonRpc/MessageFactory.php

@@ -37,7 +37,7 @@ final class MessageFactory
     /**
      * Registry of all known message classes that have methods.
      *
-     * @var array<int, class-string<Request|Notification>>
+     * @var list<class-string<Request>|class-string<Notification>>
      */
     private const REGISTERED_MESSAGES = [
         Schema\Notification\CancelledNotification::class,
@@ -68,7 +68,7 @@ final class MessageFactory
     ];
 
     /**
-     * @param array<int, class-string<Request|Notification>> $registeredMessages
+     * @param list<class-string<Request>|class-string<Notification>> $registeredMessages
      */
     public function __construct(
         private readonly array $registeredMessages,
@@ -151,7 +151,7 @@ private function createMessage(array $data): MessageInterface
     /**
      * Finds the registered message class for a given method name.
      *
-     * @return class-string<Request|Notification>
+     * @return class-string<Request>|class-string<Notification>
      *
      * @throws InvalidInputMessageException
      */

src/Server/Session/Psr16StoreSession.php

@@ -17,12 +17,12 @@
 use Symfony\Component\Uid\Uuid;
 
 /**
- * @author luoyue <1569097443@qq.com>
- *
  * PSR-16 compliant cache-based session store.
  *
  * This implementation uses any PSR-16 compliant cache as the storage backend
  * for session data. Each session is stored with a prefixed key using the session ID.
+ *
+ * @author luoyue <1569097443@qq.com>
  */
 class Psr16StoreSession implements SessionStoreInterface
 {