Skip to content

Commit 214da3e

Browse files
author
Volodymyr Panivko
committed
Merge branch 'main' of https://github.com/modelcontextprotocol/php-sdk into middleware
2 parents 6988e5b + 940eb90 commit 214da3e

File tree

114 files changed

+2303
-1011
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

114 files changed

+2303
-1011
lines changed

‎.github/workflows/docs.yml‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
name: Deploy Documentation
2+
3+
on:
4+
release:
5+
types: [published]
6+
workflow_dispatch:
7+
8+
permissions:
9+
contents: write
10+
11+
jobs:
12+
deploy:
13+
runs-on: ubuntu-latest
14+
steps:
15+
- name: Checkout
16+
uses: actions/checkout@v5
17+
18+
- name: Setup PHP
19+
uses: shivammathur/setup-php@v2
20+
with:
21+
php-version: '8.4'
22+
coverage: "none"
23+
24+
- name: Install Composer
25+
uses: "ramsey/composer-install@v3"
26+
27+
- name: Generate Documentation
28+
run: make docs
29+
30+
- name: Deploy to gh-pages branch
31+
uses: peaceiris/actions-gh-pages@v4
32+
with:
33+
github_token: ${{ secrets.GITHUB_TOKEN }}
34+
publish_dir: ./.phpdoc/build
35+
enable_jekyll: false

‎.github/workflows/pipeline.yaml‎

Lines changed: 35 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -75,12 +75,6 @@ jobs:
7575
- name: Checkout
7676
uses: actions/checkout@v5
7777

78-
- name: Setup PHP
79-
uses: shivammathur/setup-php@v2
80-
with:
81-
php-version: '8.4'
82-
coverage: "none"
83-
8478
- name: Setup Node
8579
uses: actions/setup-node@v5
8680
with:
@@ -89,25 +83,41 @@ jobs:
8983
- name: Install Composer
9084
uses: "ramsey/composer-install@v3"
9185

92-
- name: Run server
93-
run: php -S localhost:8000 examples/server/conformance/server.php &
86+
- name: Start conformance server
87+
run: |
88+
mkdir -p tests/Conformance/sessions tests/Conformance/logs
89+
chmod -R 777 tests/Conformance/sessions tests/Conformance/logs
90+
docker compose -f tests/Conformance/Fixtures/docker-compose.yml up -d
91+
sleep 5
9492
95-
- name: Wait for server to start
96-
run: sleep 5
93+
- name: Run conformance tests
94+
working-directory: ./tests/Conformance
95+
run: npx @modelcontextprotocol/conformance server --url http://localhost:8000/ --expected-failures conformance-baseline.yml
9796

98-
- name: Tests
97+
- name: Show logs on failure
98+
if: failure()
9999
run: |
100-
exit_code=0
101-
OUTPUT=$(npx @modelcontextprotocol/conformance server --url http://localhost:8000/) || exit_code=1
102-
echo "$OUTPUT"
103-
104-
# Example: "Total: 3 passed, 16 failed"
105-
passedTests=$(echo "$OUTPUT" | sed -nE 's/.*Total: ([0-9]+) passed.*/\1/p')
106-
passedTests=${passedTests:-0}
107-
108-
REQUIRED_TESTS_TO_PASS=20
109-
echo "Required tests to pass: $REQUIRED_TESTS_TO_PASS"
110-
[ "$passedTests" -ge "$REQUIRED_TESTS_TO_PASS" ] || exit $exit_code
100+
echo "=== Docker Compose Logs ==="
101+
docker compose -f tests/Conformance/Fixtures/docker-compose.yml logs
102+
echo ""
103+
echo "=== Conformance Log ==="
104+
cat tests/Conformance/logs/conformance.log 2>/dev/null || echo "No conformance log found"
105+
echo ""
106+
echo "=== Test Results (first failed test) ==="
107+
find tests/Conformance/results -name "checks.json" 2>/dev/null | head -3 | while read f; do
108+
echo "--- $f ---"
109+
cat "$f"
110+
echo ""
111+
done || echo "No results found"
112+
echo ""
113+
echo "=== Directory permissions ==="
114+
ls -la tests/Conformance/
115+
ls -la tests/Conformance/logs/ 2>/dev/null || echo "logs dir issue"
116+
ls -la tests/Conformance/sessions/ 2>/dev/null || echo "sessions dir issue"
117+
118+
- name: Cleanup
119+
if: always()
120+
run: docker compose -f tests/Conformance/Fixtures/docker-compose.yml down
111121

112122
qa:
113123
runs-on: ubuntu-latest
@@ -132,3 +142,6 @@ jobs:
132142

133143
- name: PHPStan
134144
run: vendor/bin/phpstan analyse
145+
146+
- name: Documentation
147+
run: make docs

‎.gitignore‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,10 @@ vendor
66
examples/**/dev.log
77
examples/**/cache
88
examples/**/sessions
9-
results
9+
tests/Conformance/results
10+
tests/Conformance/sessions
11+
tests/Conformance/logs/*.log
12+
13+
# phpDocumentor
14+
.phpdoc/build/
15+
.phpdoc/cache/

‎.phpdoc/template/base.html.twig‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
{% extends 'layout.html.twig' %}
2+
3+
{% set topMenu = {
4+
"menu": [
5+
{ "name": "Guides", "url": "docs/index.html"},
6+
{ "name": "Specification", "url": "https://modelcontextprotocol.io/" }
7+
],
8+
"social": [
9+
{ "iconClass": "fab fa-github", "url": "https://github.com/modelcontextprotocol/php-sdk"},
10+
{ "iconClass": "fab fa-discord", "url": "https://discord.gg/6CSzBmMkjX"}
11+
]
12+
}
13+
%}

‎.phpdoc/template/components/header-title.html.twig‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
<h1 class="phpdocumentor-title">
2+
<a href="{{ path('/docs/index.html') }}" class="phpdocumentor-title__link">
3+
<svg xmlns="http://www.w3.org/2000/svg" width="40" height="40" viewBox="0 0 195 195" fill="none">
4+
<path d="M25 97.8528L92.8823 29.9706C102.255 20.598 117.451 20.598 126.823 29.9706V29.9706C136.196 39.3431 136.196 54.5391 126.823 63.9117L75.5581 115.177" stroke="black" stroke-width="12" stroke-linecap="round"/>
5+
<path d="M76.2653 114.47L126.823 63.9117C136.196 54.5391 151.392 54.5391 160.765 63.9117L161.118 64.2652C170.491 73.6378 170.491 88.8338 161.118 98.2063L99.7248 159.6C96.6006 162.724 96.6006 167.789 99.7248 170.913L112.331 183.52" stroke="black" stroke-width="12" stroke-linecap="round"/>
6+
<path d="M109.853 46.9411L59.6482 97.1457C50.2757 106.518 50.2757 121.714 59.6482 131.087V131.087C69.0208 140.459 84.2168 140.459 93.5894 131.087L143.794 80.8822" stroke="black" stroke-width="12" stroke-linecap="round"/>
7+
</svg>
8+
<span style="margin-left: 0.25em;">{{ project.name }}</span>
9+
</a>
10+
</h1>

‎CHANGELOG.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,15 @@
22

33
All notable changes to `mcp/sdk` will be documented in this file.
44

5+
0.3.0
6+
-----
7+
8+
* Add output schema support to MCP tools
9+
* Add validation of the input parameters given to a Tool.
10+
* Rename `Mcp\Capability\Registry\ResourceReference::$schema` to `Mcp\Capability\Registry\ResourceReference::$resource`.
11+
* Introduce `SchemaGeneratorInterface` and `DiscovererInterface` to allow custom schema generation and discovery implementations.
12+
* Remove `DocBlockParser::getSummary()` method, use `DocBlockParser::getDescription()` instead.
13+
514
0.2.2
615
-----
716

‎LICENSE‎

Lines changed: 201 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,200 @@
1+
The MCP project is undergoing a licensing transition from the MIT License to the Apache License, Version 2.0 ("Apache-2.0"). All new code and specification contributions to the project are licensed under Apache-2.0. Documentation contributions (excluding specifications) are licensed under CC-BY-4.0.
2+
3+
Contributions for which relicensing consent has been obtained are licensed under Apache-2.0. Contributions made by authors who originally licensed their work under the MIT License and who have not yet granted explicit permission to relicense remain licensed under the MIT License.
4+
5+
No rights beyond those granted by the applicable original license are conveyed for such contributions.
6+
7+
---
8+
9+
Apache License
10+
Version 2.0, January 2004
11+
http://www.apache.org/licenses/
12+
13+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
14+
15+
1. Definitions.
16+
17+
"License" shall mean the terms and conditions for use, reproduction,
18+
and distribution as defined by Sections 1 through 9 of this document.
19+
20+
"Licensor" shall mean the copyright owner or entity authorized by
21+
the copyright owner that is granting the License.
22+
23+
"Legal Entity" shall mean the union of the acting entity and all
24+
other entities that control, are controlled by, or are under common
25+
control with that entity. For the purposes of this definition,
26+
"control" means (i) the power, direct or indirect, to cause the
27+
direction or management of such entity, whether by contract or
28+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
29+
outstanding shares, or (iii) beneficial ownership of such entity.
30+
31+
"You" (or "Your") shall mean an individual or Legal Entity
32+
exercising permissions granted by this License.
33+
34+
"Source" form shall mean the preferred form for making modifications,
35+
including but not limited to software source code, documentation
36+
source, and configuration files.
37+
38+
"Object" form shall mean any form resulting from mechanical
39+
transformation or translation of a Source form, including but
40+
not limited to compiled object code, generated documentation,
41+
and conversions to other media types.
42+
43+
"Work" shall mean the work of authorship, whether in Source or
44+
Object form, made available under the License, as indicated by a
45+
copyright notice that is included in or attached to the work
46+
(an example is provided in the Appendix below).
47+
48+
"Derivative Works" shall mean any work, whether in Source or Object
49+
form, that is based on (or derived from) the Work and for which the
50+
editorial revisions, annotations, elaborations, or other modifications
51+
represent, as a whole, an original work of authorship. For the purposes
52+
of this License, Derivative Works shall not include works that remain
53+
separable from, or merely link (or bind by name) to the interfaces of,
54+
the Work and Derivative Works thereof.
55+
56+
"Contribution" shall mean any work of authorship, including
57+
the original version of the Work and any modifications or additions
58+
to that Work or Derivative Works thereof, that is intentionally
59+
submitted to the Licensor for inclusion in the Work by the copyright
60+
owner or by an individual or Legal Entity authorized to submit on behalf
61+
of the copyright owner. For the purposes of this definition, "submitted"
62+
means any form of electronic, verbal, or written communication sent
63+
to the Licensor or its representatives, including but not limited to
64+
communication on electronic mailing lists, source code control systems,
65+
and issue tracking systems that are managed by, or on behalf of, the
66+
Licensor for the purpose of discussing and improving the Work, but
67+
excluding communication that is conspicuously marked or otherwise
68+
designated in writing by the copyright owner as "Not a Contribution."
69+
70+
"Contributor" shall mean Licensor and any individual or Legal Entity
71+
on behalf of whom a Contribution has been received by Licensor and
72+
subsequently incorporated within the Work.
73+
74+
2. Grant of Copyright License. Subject to the terms and conditions of
75+
this License, each Contributor hereby grants to You a perpetual,
76+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77+
copyright license to reproduce, prepare Derivative Works of,
78+
publicly display, publicly perform, sublicense, and distribute the
79+
Work and such Derivative Works in Source or Object form.
80+
81+
3. Grant of Patent License. Subject to the terms and conditions of
82+
this License, each Contributor hereby grants to You a perpetual,
83+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
84+
(except as stated in this section) patent license to make, have made,
85+
use, offer to sell, sell, import, and otherwise transfer the Work,
86+
where such license applies only to those patent claims licensable
87+
by such Contributor that are necessarily infringed by their
88+
Contribution(s) alone or by combination of their Contribution(s)
89+
with the Work to which such Contribution(s) was submitted. If You
90+
institute patent litigation against any entity (including a
91+
cross-claim or counterclaim in a lawsuit) alleging that the Work
92+
or a Contribution incorporated within the Work constitutes direct
93+
or contributory patent infringement, then any patent licenses
94+
granted to You under this License for that Work shall terminate
95+
as of the date such litigation is filed.
96+
97+
4. Redistribution. You may reproduce and distribute copies of the
98+
Work or Derivative Works thereof in any medium, with or without
99+
modifications, and in Source or Object form, provided that You
100+
meet the following conditions:
101+
102+
(a) You must give any other recipients of the Work or
103+
Derivative Works a copy of this License; and
104+
105+
(b) You must cause any modified files to carry prominent notices
106+
stating that You changed the files; and
107+
108+
(c) You must retain, in the Source form of any Derivative Works
109+
that You distribute, all copyright, patent, trademark, and
110+
attribution notices from the Source form of the Work,
111+
excluding those notices that do not pertain to any part of
112+
the Derivative Works; and
113+
114+
(d) If the Work includes a "NOTICE" text file as part of its
115+
distribution, then any Derivative Works that You distribute must
116+
include a readable copy of the attribution notices contained
117+
within such NOTICE file, excluding those notices that do not
118+
pertain to any part of the Derivative Works, in at least one
119+
of the following places: within a NOTICE text file distributed
120+
as part of the Derivative Works; within the Source form or
121+
documentation, if provided along with the Derivative Works; or,
122+
within a display generated by the Derivative Works, if and
123+
wherever such third-party notices normally appear. The contents
124+
of the NOTICE file are for informational purposes only and
125+
do not modify the License. You may add Your own attribution
126+
notices within Derivative Works that You distribute, alongside
127+
or as an addendum to the NOTICE text from the Work, provided
128+
that such additional attribution notices cannot be construed
129+
as modifying the License.
130+
131+
You may add Your own copyright statement to Your modifications and
132+
may provide additional or different license terms and conditions
133+
for use, reproduction, or distribution of Your modifications, or
134+
for any such Derivative Works as a whole, provided Your use,
135+
reproduction, and distribution of the Work otherwise complies with
136+
the conditions stated in this License.
137+
138+
5. Submission of Contributions. Unless You explicitly state otherwise,
139+
any Contribution intentionally submitted for inclusion in the Work
140+
by You to the Licensor shall be under the terms and conditions of
141+
this License, without any additional terms or conditions.
142+
Notwithstanding the above, nothing herein shall supersede or modify
143+
the terms of any separate license agreement you may have executed
144+
with Licensor regarding such Contributions.
145+
146+
6. Trademarks. This License does not grant permission to use the trade
147+
names, trademarks, service marks, or product names of the Licensor,
148+
except as required for reasonable and customary use in describing the
149+
origin of the Work and reproducing the content of the NOTICE file.
150+
151+
7. Disclaimer of Warranty. Unless required by applicable law or
152+
agreed to in writing, Licensor provides the Work (and each
153+
Contributor provides its Contributions) on an "AS IS" BASIS,
154+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
155+
implied, including, without limitation, any warranties or conditions
156+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
157+
PARTICULAR PURPOSE. You are solely responsible for determining the
158+
appropriateness of using or redistributing the Work and assume any
159+
risks associated with Your exercise of permissions under this License.
160+
161+
8. Limitation of Liability. In no event and under no legal theory,
162+
whether in tort (including negligence), contract, or otherwise,
163+
unless required by applicable law (such as deliberate and grossly
164+
negligent acts) or agreed to in writing, shall any Contributor be
165+
liable to You for damages, including any direct, indirect, special,
166+
incidental, or consequential damages of any character arising as a
167+
result of this License or out of the use or inability to use the
168+
Work (including but not limited to damages for loss of goodwill,
169+
work stoppage, computer failure or malfunction, or any and all
170+
other commercial damages or losses), even if such Contributor
171+
has been advised of the possibility of such damages.
172+
173+
9. Accepting Warranty or Additional Liability. While redistributing
174+
the Work or Derivative Works thereof, You may choose to offer,
175+
and charge a fee for, acceptance of support, warranty, indemnity,
176+
or other liability obligations and/or rights consistent with this
177+
License. However, in accepting such obligations, You may act only
178+
on Your own behalf and on Your sole responsibility, not on behalf
179+
of any other Contributor, and only if You agree to indemnify,
180+
defend, and hold each Contributor harmless for any liability
181+
incurred by, or claims asserted against, such Contributor by reason
182+
of your accepting any such warranty or additional liability.
183+
184+
END OF TERMS AND CONDITIONS
185+
186+
---
187+
1188
MIT License
2189

190+
Copyright (c) 2024-2025 Model Context Protocol a Series of LF Projects, LLC.
191+
3192
Permission is hereby granted, free of charge, to any person obtaining a copy
4193
of this software and associated documentation files (the "Software"), to deal
5194
in the Software without restriction, including without limitation the rights
6195
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
7-
copies of the Software, and to permit persons to whom the Software is furnished
8-
to do so, subject to the following conditions:
196+
copies of the Software, and to permit persons to whom the Software is
197+
furnished to do so, subject to the following conditions:
9198

10199
The above copyright notice and this permission notice shall be included in all
11200
copies or substantial portions of the Software.
@@ -15,5 +204,13 @@ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15204
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
16205
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17206
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
18-
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
19-
THE SOFTWARE.
207+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
208+
SOFTWARE.
209+
210+
---
211+
212+
Creative Commons Attribution 4.0 International (CC-BY-4.0)
213+
214+
Documentation in this project (excluding specifications) is licensed under
215+
CC-BY-4.0. See https://creativecommons.org/licenses/by/4.0/legalcode for
216+
the full license text.

0 commit comments

Comments
 (0)