Home
About
Blog
Products
Forum
Support
Contact
Sunbelt Computer Software
PL/B Language Development and Support
Home
About
Blog
Products
Forum
Support
Contact
php-sdk/tests/Integration/SamplingTest.php at main · modelcontextprotocol/php-sdk · GitHub
Skip to content
Navigation Menu
Sign in
Appearance settings
Platform
AI CODE CREATION
GitHub Copilot
Write better code with AI
GitHub Copilot app
Direct agents from issue to merge
MCP Registry
Integrate external tools
DEVELOPER WORKFLOWS
Actions
Automate any workflow
Codespaces
Instant dev environments
Issues
Plan and track work
Code Review
Manage code changes
Code Quality
Enforce quality at merge
APPLICATION SECURITY
GitHub Advanced Security
Find and fix vulnerabilities
Code security
Secure your code as you build
Secret protection
Stop leaks before they start
EXPLORE
Why GitHub
Documentation
Blog
Changelog
Marketplace
View all features
Solutions
BY COMPANY SIZE
Enterprises
Small and medium teams
Startups
Nonprofits
BY USE CASE
App Modernization
DevSecOps
DevOps
CI/CD
View all use cases
BY INDUSTRY
Healthcare
Financial services
Manufacturing
Government
View all industries
View all solutions
Resources
EXPLORE BY TOPIC
AI
Software Development
DevOps
Security
View all topics
EXPLORE BY TYPE
Customer stories
Events & webinars
Ebooks & reports
Business insights
GitHub Skills
SUPPORT & SERVICES
Documentation
Customer support
Community forum
Trust center
Partners
View all resources
Open Source
COMMUNITY
GitHub Sponsors
Fund open source developers
PROGRAMS
Security Lab
Maintainer Community
GitHub Stars
Archive Program
REPOSITORIES
Topics
Trending
Collections
Enterprise
ENTERPRISE SOLUTIONS
Enterprise platform
AI-powered developer platform
AVAILABLE ADD-ONS
GitHub Advanced Security
Enterprise-grade security features
Copilot for Business
Enterprise-grade AI features
Premium Support
Enterprise-grade 24/7 support
Pricing
Search
/
Sign in
Sign up
Appearance settings
You signed in with another tab or window.
Reload
to refresh your session.
You signed out in another tab or window.
Reload
to refresh your session.
You switched accounts on another tab or window.
Reload
to refresh your session.
Dismiss alert
{{ message }}
modelcontextprotocol
php-sdk
Repository navigation
Code
Issues
48
(48)
Pull requests
9
(9)
Actions
Projects
Security and quality
1
(1)
Insights
More
items
Files
Expand file tree
main
Breadcrumbs
php-sdk
/
tests
/
Integration
/
SamplingTest.php
Copy path
Blame
More file actions
Blame
More file actions
Latest commit
History
History
History
168 lines (136 loc) · 6.82 KB
main
Breadcrumbs
php-sdk
/
tests
/
Integration
/
SamplingTest.php
Copy path
Top
File metadata and controls
Code
Blame
168 lines (136 loc) · 6.82 KB
Raw
Copy raw file
Download raw file
Open symbols panel
Edit and raw actions
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
<?php
/*
* This file is part of the official PHP MCP SDK.
*
* A collaboration between Symfony and the PHP Foundation.
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace
Mcp
\
Tests
\
Integration
;
use
Mcp
\
Client
\
Builder
as
ClientBuilder
;
use
Mcp
\
Client
\
Handler
\
Request
\
SamplingCallbackInterface
;
use
Mcp
\
Client
\
Handler
\
Request
\
SamplingRequestHandler
;
use
Mcp
\
Exception
\
RequestException
;
use
Mcp
\
Schema
\
ClientCapabilities
;
use
Mcp
\
Schema
\
Content
\
TextContent
;
use
Mcp
\
Schema
\
Enum
\
ProtocolVersion
;
use
Mcp
\
Schema
\
Enum
\
Role
;
use
Mcp
\
Schema
\
Request
\
CreateSamplingMessageRequest
;
use
Mcp
\
Schema
\
Result
\
CreateSamplingMessageResult
;
use
PHPUnit
\
Framework
\
Attributes
\
TestDox
;
/**
* Sampling: the server borrowing the client's model mid-tool-call.
*
* @see Fixture/sampling.php for the server under test
*/
final
class
SamplingTest
extends
IntegrationTestCase
{
/**
* The gateway call-out exists only on the handshake era, so a client and
* server that could both settle on the modern era are kept off it.
*/
protected
function
clientBuilder
():
ClientBuilder
{
return
parent
::
clientBuilder
()->
setProtocolVersion
(ProtocolVersion::
V2025_11_25
);
}
#[TestDox(
'
the sampled completion reaches the tool that asked for it
'
)]
public
function
testSampledCompletionReachesTheTool
():
void
{
$
client
=
$
this
->
connect
(
'
sampling
'
,
$
this
->
clientSampling
());
$
result
=
$
client
->
callTool
(
'
summarize
'
, [
'
text
'
=>
'
a long report
'
]);
$
this
->
assertInstanceOf
(TextContent::class,
$
result
->
content
[
0
]);
$
this
->
assertSame
(
'
test-model said: a long report
'
,
$
result
->
content
[
0
]->
text
);
}
#[TestDox(
'
the prompt the tool passed arrives at the client
'
)]
public
function
testPromptReachesTheClient
():
void
{
// The client stays in this process, so what it was asked can be
// collected by reference even though the tool asking runs in another.
/** @var \ArrayObject<int, CreateSamplingMessageRequest> $seen */
$
seen
=
new
\
ArrayObject
();
$
client
=
$
this
->
connect
(
'
sampling
'
,
$
this
->
clientSampling
(
$
seen
));
$
client
->
callTool
(
'
summarize
'
, [
'
text
'
=>
'
inspect me
'
]);
$
this
->
assertCount
(
1
,
$
seen
);
$
request
=
$
seen
[
0
];
$
this
->
assertInstanceOf
(CreateSamplingMessageRequest::class,
$
request
);
$
this
->
assertInstanceOf
(TextContent::class,
$
request
->
messages
[
0
]->
content
);
$
this
->
assertSame
(
'
inspect me
'
,
$
request
->
messages
[
0
]->
content
->
text
);
$
this
->
assertSame
(
64
,
$
request
->
maxTokens
);
}
#[TestDox(
'
a gateway parameter is injected, not published in the schema
'
)]
public
function
testGatewayParameterIsInjectedNotPublished
():
void
{
$
client
=
$
this
->
connect
(
'
sampling
'
,
$
this
->
clientSampling
());
$
tool
=
null
;
foreach
(
$
client
->
listTools
()->
tools
as
$
candidate
) {
if
(
'
summarize_via_gateway
'
===
$
candidate
->
name
) {
$
tool
=
$
candidate
;
}
}
$
this
->
assertNotNull
(
$
tool
);
$
properties
=
$
tool
->
inputSchema
[
'
properties
'
] ??
null
;
$
this
->
assertIsArray
(
$
properties
);
$
this
->
assertArrayNotHasKey
(
'
client
'
,
$
properties
);
$
this
->
assertArrayHasKey
(
'
text
'
,
$
properties
);
$
this
->
assertSame
([
'
text
'
],
$
tool
->
inputSchema
[
'
required
'
] ??
null
);
$
result
=
$
client
->
callTool
(
'
summarize_via_gateway
'
, [
'
text
'
=>
'
a long report
'
]);
$
this
->
assertInstanceOf
(TextContent::class,
$
result
->
content
[
0
]);
$
this
->
assertSame
(
'
test-model said: a long report
'
,
$
result
->
content
[
0
]->
text
);
}
#[TestDox(
'
a client that cannot sample refuses instead of stalling the tool
'
)]
public
function
testClientWithoutSamplingRefuses
():
void
{
// The gateway has no supportsSampling() to consult, so the tool finds
// out by asking and the refusal surfaces as a ClientException.
$
client
=
$
this
->
connect
(
'
sampling
'
);
$
result
=
$
client
->
callTool
(
'
summarize
'
, [
'
text
'
=>
'
anything
'
]);
$
this
->
assertInstanceOf
(TextContent::class,
$
result
->
content
[
0
]);
$
this
->
assertSame
(
'
Client does not handle "sampling/createMessage" requests.
'
,
$
result
->
content
[
0
]->
text
);
}
#[TestDox(
'
a tool that samples tells a client on the modern era it cannot, rather than hanging
'
)]
public
function
testSamplingIsUnavailableOnTheModernEra
():
void
{
$
client
=
$
this
->
connect
(
'
sampling
'
,
$
this
->
clientSampling
()->
setProtocolVersion
(ProtocolVersion::
V2026_07_28
));
$
this
->
assertSame
(ProtocolVersion::
V2026_07_28
,
$
client
->
getProtocolVersion
());
try
{
$
client
->
callTool
(
'
summarize
'
, [
'
text
'
=>
'
hello
'
]);
$
this
->
fail
(
'
Sampling must not be sent from inside a request on 2026-07-28.
'
);
}
catch
(
RequestException
$
e
) {
$
this
->
assertStringContainsString
(
'
"sampling/createMessage"
'
,
$
e
->
getMessage
());
$
this
->
assertStringContainsString
(
'
InputRequiredResult
'
,
$
e
->
getMessage
());
}
}
#[TestDox(
'
a sampling ask the tool returns is answered on the modern era a default client settles on
'
)]
public
function
testReturnedAskIsAnsweredOnTheModernEra
():
void
{
$
client
=
$
this
->
connect
(
'
sampling
'
,
$
this
->
clientSampling
(on:
parent
::
clientBuilder
()));
$
this
->
assertSame
(ProtocolVersion::
V2026_07_28
,
$
client
->
getProtocolVersion
());
$
result
=
$
client
->
callTool
(
'
summarize_by_asking
'
, [
'
text
'
=>
'
a long report
'
]);
$
this
->
assertInstanceOf
(TextContent::class,
$
result
->
content
[
0
]);
$
this
->
assertSame
(
'
test-model said: a long report
'
,
$
result
->
content
[
0
]->
text
);
}
/**
* @param \ArrayObject<int, CreateSamplingMessageRequest>|null $seen collects what the server asked for
* @param ClientBuilder|null $on a builder other than this test's era-pinned one
*/
private
function
clientSampling
(?
\
ArrayObject
$
seen
=
null
, ?
ClientBuilder
$
on
=
null
):
ClientBuilder
{
$
callback
=
new
class
(
$
seen
??
new
\
ArrayObject
())
implements
SamplingCallbackInterface {
/** @param \ArrayObject<int, CreateSamplingMessageRequest> $seen */
public
function
__construct
(
private
readonly
\
ArrayObject
$
seen
)
{
}
public
function
__invoke
(
CreateSamplingMessageRequest
$
request
):
CreateSamplingMessageResult
{
$
this
->
seen
[] =
$
request
;
$
prompt
=
$
request
->
messages
[
0
]->
content
;
\assert
(
$
prompt
instanceof
TextContent);
return
new
CreateSamplingMessageResult
(Role::Assistant,
new
TextContent
(
$
prompt
->
text
),
'
test-model
'
);
}
};
return
(
$
on
??
$
this
->
clientBuilder
())
->
setCapabilities
(
new
ClientCapabilities
(sampling:
true
))
->
addRequestHandler
(
new
SamplingRequestHandler
(
$
callback
));
}
}
You can’t perform that action at this time.