blib/lib/AnyEvent/MCP/Server/Request.pm

filter: Statementstmt 100% 45 / 45 Branchbran 71.4% 20 / 28 Conditioncond 66.6% 2 / 3 MC/DCmcdc 50.0% 1 / 2 Subroutinesub 100% 10 / 10 Podpod 100% 7 / 7 totaltotal 89.4% 85 / 95 CC 16 SCAR 14.3
CC
16
Cov
88%
progress
7.7
cancel
5.0
reply
3.0
CRAP 4.2
« blib/lib/AnyEvent/MCP/Helper.pm ↑ Summary blib/lib/AnyEvent/MCP/Client/Request.pm »
1 =head1 NAME
2  
3 AnyEvent::MCP::Server::Request - one MCP request
4  
5 =head1 DESCRIPTION
6  
7 Each incoming request gets a Request object. The handler can reply
8 immediately, or keep the object and reply when asynchronous work finishes.
9 Returning from the handler does not complete the request; calling
10 C<reply>, C<result> or C<error> does.
11  
12 There is one important consequence: do not reply after cancellation or after
13 another callback has already completed the request. Check C<finished> in
14 late asynchronous callbacks. A second reply is a programming error.
15  
16 You normally receive this object as the first argument to a
17 L<AnyEvent::MCP::Server::Toolset> callback. See
18 L<AnyEvent::MCP::Server::Simple/TUTORIAL> for complete synchronous and
19 asynchronous examples rather than constructing requests yourself.
20  
21 =head1 PUBLIC FIELDS
22  
23 Request fields are accessed directly through the hash.
24  
25 =over
26  
27 =item $req->{server}
28  
29 The server handling this request.
30  
31 =item $req->{id}
32  
33 The JSON-RPC request id, used to associate the response with the request.
34  
35 =item $req->{method}
36  
37 The JSON-RPC method name, such as C<tools/call>.
38  
39 =item $req->{protocol_version}
40  
41 The protocol revision used for this request. Modern requests supply it in
42 C<_meta>; legacy requests use the initialized peer or HTTP version.
43  
44 =item $req->{peer}
45  
46 The connection's peer hash reference, supplied by the transport or embedder.
47 It holds transport context and legacy state, rather than a user identity.
48 Modern client identity and capabilities come from this request's C<_meta>.
49  
50 =item $req->{params}
51  
52 The original decoded JSON-RPC parameters. For a tool call, this hash contains
53 C<name>, C<arguments> and any C<_meta> supplied by the client. These are the
54 protocol parameters, rather than just the tool arguments.
55  
56 =item $req->{tool}
57  
58 The tool name from C<< $req->{params}{name} >>. Present for tool calls.
59  
60 =item $req->{args}
61  
62 The tool argument hash reference from C<< $req->{params}{arguments} >>.
63 Present for tool calls. The tool callback also receives this same reference
64 as its second parameter, for convenience.
65  
66 =item $req->{toolset}
67  
68 The Toolset invoking the tool callback. Set by the Toolset when it dispatches
69 the call; absent for requests dispatched without a Toolset.
70  
71 =item $req->{finished}
72  
73 True after a reply or cancellation. Replying to a finished request is an
74 error. Notifications and progress after completion are ignored.
75  
76 =item $req->{cancelled}
77  
78 True if the request was cancelled. An asynchronous handler can check this
79 before attempting to reply.
80  
81 =back
82  
83 =head1 METHODS
84  
85 =over
86  
87 =item $grant = $req->require_permission ({ %request })
88  
89 Synchronously checks a permission request using the server's C<permissions>
90 object. C<%request> has the fields described by
91 L<AnyEvent::MCP::Server::Permissions/check>. Returns the granted sandbox-grant
92 array reference; it can be reduced from the requested set.
93  
94 A denial dies. A missing permission throws a special exception handled by
95 Server, which asks and retries the handler. Multiple checks are supported:
96 one-time grants belong to this tool invocation and survive permission retries.
97 They do not authorize later calls. Current rules are checked on every retry.
98  
99 Complete all checks before side effects or asynchronous work starts.
100 The handler can run more than once. Do not catch the permission exception
101 as an ordinary tool error; let it reach Server's dispatch boundary.
102  
103 =item $req->reply ($result)
104  
105 Completes the request with the MCP result hash reference C<$result>. The
106 server adds the JSON-RPC envelope. Tools do not construct JSON-RPC errors.
107 Dies if the request has already finished.
108  
109 Use this method for arbitrary MCP results, including structured errors,
110 large results and results requiring a particular content representation.
111  
112 =item $req->error ($message)
113  
114 Replies with C<isError> set to true and C<$message> as one text content item.
115 Use C<reply> for errors with structured content or other content types.
116  
117 =item $req->result ($data)
118  
119 Replies with the hash reference C<$data> as C<structuredContent>, and its
120 JSON encoding as one text content item for clients that consume only text.
121  
122 This deliberately duplicates the data. Use C<reply> for large results or
123 when JSON text is unsuitable, including clients that encode text as JSON
124 again. Arrays and scalars must be wrapped in an object explicitly.
125  
126 =item $req->notify ($method, $params)
127  
128 Sends a notification associated with this request. C<$method> is the
129 notification method name and C<$params> its parameter hash reference.
130  
131 A notification does not complete the request. Delivery is best effort:
132 notifications can be dropped if the transport does not implement delivery.
133 Calls after completion are ignored.
134  
135 =item $req->progress ($progress, $total, $message)
136  
137 Sends a progress notification if the client supplied a progress token in
138 C<< $req->{params}{_meta}{progressToken} >>. C<$progress> is the amount
139 completed; C<$total> and C<$message> can be omitted or undefined.
140  
141 Uses C<notify>, with the same best-effort delivery. Calls after completion
142 are ignored.
143  
144 =item $req->cancel ($reason)
145  
146 Marks the request as cancelled and calls C<on_cancel>, allowing the handler
147 to stop work and release resources. C<$reason> is an optional explanation.
148  
149 Cancellation completes the transport's request bookkeeping without sending
150 a JSON-RPC response.
151  
152 =back
153  
154 =head1 EVENTS
155  
156 These callbacks are stored in the request hash like other MCP events.
157  
158 =over
159  
160 =item on_reply => $callback->($req, $result)
161  
162 Called once when the request is completed with C<reply>. The server installs
163 C<$callback> to deliver the result.
164  
165 =item on_notify => $callback->($req, $method, $params)
166  
167 Called for each notification while the request is active. The server installs
168 C<$callback> to deliver notifications through the transport.
169  
170 =item on_cancel => $callback->($req, $reason)
171  
172 Called once when the request is cancelled. A handler can set C<$callback>
173 to cancel its asynchronous operation.
174  
175 =back
176  
177 =cut
178  
179 package AnyEvent::MCP::Server::Request;
180  
181 269 ▶use common::sense;
Subroutine BEGIN: called CC=1 SCAR=0.0
182 269 ▶use AnyEvent::MCP ();
Subroutine BEGIN: called CC=1 SCAR=0.0
183 269 ▶use JSON::XS ();
Subroutine BEGIN: called CC=1 SCAR=0.0
184  
185 269 our @ISA = qw(AnyEvent::MCP::Base);
186  
187 3089 ▶sub require_permission {
Subroutine require_permission: called CC=2 SCAR=6.9
Pod documented
188 3089 my ($self, $request) = @_;
189  
190 my $permissions = $self->{server}{permissions}
191 3089 ▶ or die "Server has no permission configuration\n";
Branch: 1 branch
BranchTrueFalseTotal
my $permissions = $self->{"server"}{"permissions"} or die "Server has no permission configuration\n" 3088 1 3089
192  
193 3088 $permissions->require_permission ($self, $request)
194 }
195  
196 4361 ▶sub reply {
Subroutine reply: called CC=3 SCAR=11.0
Pod documented
197 4361 my ($self, $result) = @_;
198  
199 die "MCP request already finished\n"
200 4361 ▶ if $self->{finished};
Branch: 1 branch
BranchTrueFalseTotal
if $self->{"finished"} 2 4359 4361
201  
202 4359 $self->{finished} = 1;
203  
204 4359 my $reply = delete $self->{on_reply};
205 4359 delete @$self{qw(on_notify on_cancel _reply)};
206  
207 4359 ▶ $reply->($self, $result) if $reply
Branch: 1 branch
BranchTrueFalseTotal
if $reply 4358 1 4359
208 }
209  
210 673 ▶sub error {
Subroutine error: called CC=1 SCAR=0.0
Pod documented
211 673 my ($self, $message) = @_;
212  
213 673 $self->reply ({
214 isError => JSON::XS::true,
215 content => [{ type => "text", text => $message }],
216 })
217 }
218  
219 186 ▶sub result {
Subroutine result: called CC=2 SCAR=7.1
Pod documented
220 186 my ($self, $data) = @_;
221  
222 186 ▶ ref $data eq "HASH"
Branch: 1 branch
BranchTrueFalseTotal
ref $data eq "HASH" or die "MCP structured result must be an object\n" 186 0 186
223 or die "MCP structured result must be an object\n";
224  
225 186 $self->reply ({
226 structuredContent => $data,
227 content => [{ type => "text", text => JSON::XS->new->encode ($data) }],
228 })
229 }
230  
231 1 ▶sub notify {
Subroutine notify: called CC=2 SCAR=7.1
Pod documented
232 1 my ($self, $method, $params) = @_;
233  
234 1 ▶ return if $self->{finished};
Branch: 1 branch
BranchTrueFalseTotal
if $self->{"finished"} 0 1 1
235  
236 1 $self->event (notify => $method, $params)
237 }
238  
239 2 ▶sub progress {
Subroutine progress: called CC=7 SCAR=20.4
Pod documented
240 2 my ($self, $progress, $total, $message) = @_;
241  
242 2 ▶ return unless $self->{on_notify} && !$self->{finished};
Branch: 1 branch
BranchTrueFalseTotal
unless $self->{"on_notify"} and not $self->{"finished"} 1 1 2
Condition66%2/3
$self->{"on_notify"} and not $self->{"finished"}
!ll&&!rl&&r
101
MC/DC50%1/2
$self->{"on_notify"} and not $self->{"finished"}
$self->{"on_notify"} not $self->{"finished"}
Truth table66%2/3
A and not(B)
A= $self->{"on_notify"}B= not $self->{"finished"}
ABresult
0X0
100
111
243  
244 my $meta = $self->{params}{_meta}
245 1 ▶ or return;
Branch: 1 branch
BranchTrueFalseTotal
my $meta = $self->{"params"}{"_meta"} or return 1 0 1
246  
247 1 ▶ return unless exists $meta->{progressToken};
Branch: 1 branch
BranchTrueFalseTotal
unless exists $meta->{"progressToken"} 0 1 1
248  
249 my $params = {
250 progressToken => $meta->{progressToken},
251 1 progress => $progress,
252 };
253  
254 1 ▶ $params->{total} = $total if defined $total;
Branch: 1 branch
BranchTrueFalseTotal
if defined $total 0 1 1
255 1 ▶ $params->{message} = $message if defined $message;
Branch: 1 branch
BranchTrueFalseTotal
if defined $message 0 1 1
256  
257 1 $self->notify ("notifications/progress", $params)
258 }
259  
260 15 ▶sub cancel {
Subroutine cancel: called CC=5 SCAR=16.2
Pod documented
261 15 my ($self, $reason) = @_;
262  
263 15 ▶ return if $self->{finished};
Branch: 1 branch
BranchTrueFalseTotal
if $self->{"finished"} 1 14 15
264 14 $self->{finished} = $self->{cancelled} = 1;
265  
266 delete $self->{peer}{requests}{$self->{id}}
267 14 ▶ if $self->{peer};
Branch: 1 branch
BranchTrueFalseTotal
if $self->{"peer"} 14 0 14
268  
269 14 my $cancel = delete $self->{on_cancel};
270 14 my $reply = delete $self->{_reply};
271 14 delete @$self{qw(on_reply on_notify)};
272  
273 14 ▶ $cancel->($self, $reason) if $cancel;
Branch: 1 branch
BranchTrueFalseTotal
if $cancel 7 7 14
274 14 ▶ $reply->(undef) if $reply
Branch: 1 branch
BranchTrueFalseTotal
if $reply 14 0 14
275 }
276  
277 269 1
« blib/lib/AnyEvent/MCP/Helper.pm ↑ Summary blib/lib/AnyEvent/MCP/Client/Request.pm »