ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/AnyEvent-MCP/lib/AnyEvent/MCP/Server/Simple.pm
Revision: 1.4
Committed: Sat Oct 10 22:43:23 2026 UTC (4 weeks, 1 day ago) by root
Branch: MAIN
Changes since 1.3: +4 -10 lines
Log Message:
*** empty log message ***

File Contents

# User Rev Content
1 root 1.1 =head1 NAME
2    
3     AnyEvent::MCP::Server::Simple - simple function interface for MCP servers
4    
5     =head1 SYNOPSIS
6    
7     use AnyEvent::MCP::Server::Simple;
8    
9     mcp_config
10     server_info => {
11     name => "example",
12     version => "0",
13     },
14     instructions => <<'EOF';
15     Use echo to return the supplied text.
16     EOF
17    
18     mcp_tool echo =>
19     "Return the supplied text.",
20     {
21     type => "object",
22     properties => { text => { type => "string" } },
23     required => ["text"],
24     },
25     sub {
26     my ($req, $args) = @_;
27    
28     $req->reply ({
29     content => [{ type => "text", text => $args->{text} }],
30     });
31     };
32    
33     mcp_start;
34    
35     =head1 DESCRIPTION
36    
37 root 1.2 For most MCP servers, registering a few tools and starting a transport is
38     enough. This module does just that: call C<mcp_tool> to register callbacks,
39     optionally configure the server with C<mcp_config>, then start it with
40     C<mcp_start>, C<mcp_stdio> or C<mcp_http>. Registration alone does not start
41     a server or an event loop.
42 root 1.1
43     Human-readable descriptions and instructions are stripped of surrounding
44     whitespace and common indentation when registered, so indented here-documents
45     can be used naturally.
46    
47     C<mcp_start>, C<mcp_stdio> and C<mcp_http> are alternative blocking entry
48 root 1.2 points for a self-contained server. They run AnyEvent until shutdown; you
49     do not start another event loop. If your application already owns the server
50     lifetime or needs several transports, use the object interfaces instead.
51    
52     Simple uses L<AnyEvent::MCP::Server> and a default Toolset internally; it is
53     not a second server implementation. Applications needing custom dispatch,
54     such as a multibroker, can use the Server API directly.
55 root 1.1
56     =head1 FUNCTIONS
57    
58     =over
59    
60     =item mcp_config %config
61    
62     Adds server configuration. Repeated calls extend or replace previously declared
63     values. C<instructions> is treated as human-readable text and normalized.
64    
65     C<server_info> contains the MCP server metadata, including C<name> and
66     C<version>. C<instructions> contains guidance for the client.
67    
68     C<on_request> is a synchronous hook called before dispatch:
69    
70     $callback->($server, $req)
71    
72     For example, an application can refresh database state before each request.
73     It does not replace dispatch or receive a completion callback. These options
74     belong to Server; Simple merely collects and passes them on.
75    
76     C<on_start> is C<$callback->($server)>, called after the transport is ready
77     and before entering the event loop. It can print application startup
78     information or install watchers. C<$server> is the underlying server object.
79     The callback must not block.
80    
81     =item mcp_tool $name, $description, $input_schema, $callback->($req, $args)
82    
83     Registers a tool named C<$name> with C<$description> and the JSON Schema
84     hash reference C<$input_schema>. C<$description> is normalized like
85     C<instructions>.
86    
87     C<$callback> receives an L<AnyEvent::MCP::Server::Request> object C<$req>
88     and its C<< $req->{args} >> hash reference as C<$args>, for convenience.
89    
90     Tools complete the request with C<< $req->reply ($result) >>, or use
91     C<< $req->result ($data) >> and C<< $req->error ($message) >> for convenience.
92     Request context is available directly in
93     the hash, for example C<< $req->{tool} >> and C<< $req->{server} >>.
94    
95     =item mcp_start %config
96    
97     Starts and runs the usual server. When
98     C<PERL_ANYEVENT_MCP_MULTIBROKER_PROTOCOL> is C<stdio>, uses C<mcp_stdio>.
99 root 1.4 Otherwise starts HTTP without printing its URL. HTTP-capable executables
100     provide C<--print-url> to retrieve the URL explicitly.
101 root 1.1
102 root 1.3 The HTTP defaults are IPv4 loopback, a stable name-derived port in
103     16384..32767, and C</> as the endpoint path.
104     The same derived token authenticates either the cookie
105 root 1.1 URL or an C<Authorization: Bearer TOKEN> header at the clean URL returned by
106     C<< $server->url (0) >>. C<anyevent-mcp token NAME> prints this token.
107    
108     C<name> selects the C<[server NAME]> configuration section and credential.
109 root 1.3 It defaults to the program's basename.
110     Named settings C<bind>, C<path>, C<url_host>, C<url_scheme>, C<cookie>,
111     C<bearer> and C<users> are loaded from the global configuration.
112     An explicit C<bind> overrides the configured bind address. Other arguments
113 root 1.1 override these settings. Explicit authentication options replace the default authentication.
114    
115     The global secret is generated automatically when needed; see
116     L<AnyEvent::MCP/GLOBAL CONFIGURATION>. No configuration is loaded for stdio.
117 root 1.4 HTTP startup neither prints to stdout nor changes its buffering.
118 root 1.1
119     =item mcp_stdio %config
120    
121     Creates and runs a server over stdin/stdout. Arguments override the collected
122     configuration. Stdout buffering is disabled. On stdin EOF, pending replies
123     finish and stdout drains before
124     this function returns. Stream errors close the connection and cancel pending
125     requests.
126    
127     =item mcp_http %config
128    
129     Creates and runs an HTTP server. For example:
130    
131     mcp_http
132     host => "127.0.0.1",
133     port => 31740,
134     path => "/mcp/";
135    
136     Arguments override the collected configuration. Unlike C<mcp_start>, this
137     function does not supply cookie authentication or print a URL; use
138     C<on_start> for application-specific startup output.
139    
140     All three starters return when the server is closed or on C<SIGINT> or
141     C<SIGTERM>. Signal shutdown closes connections and cancels outstanding
142     requests. The signal watchers belong to the blocking call.
143    
144     =back
145    
146     =cut
147    
148     package AnyEvent::MCP::Server::Simple;
149    
150     use common::sense;
151     use AnyEvent ();
152     use AnyEvent::MCP ();
153     use AnyEvent::MCP::Server::Toolset ();
154     use Exporter ();
155    
156     our @ISA = qw(Exporter);
157     our @EXPORT = qw(mcp_config mcp_tool mcp_start mcp_stdio mcp_http);
158    
159     my %config;
160     my $toolset = AnyEvent::MCP::Server::Toolset->new;
161    
162     sub _run;
163    
164     sub mcp_config {
165     my %kv = @_;
166    
167     $kv{instructions} = AnyEvent::MCP::_clean_text $kv{instructions}
168     if exists $kv{instructions};
169    
170     @config{keys %kv} = values %kv;
171     }
172    
173     sub mcp_tool {
174     $toolset->tool (@_)
175     }
176    
177     sub mcp_start {
178 root 1.3 require AnyEvent::MCP::Config;
179 root 1.1
180     my %kv = (%config, @_);
181 root 1.3 my $name = AnyEvent::MCP::Config::server_name ($kv{name});
182 root 1.1
183     $kv{name} = $name;
184     $kv{server_info} ||= { name => $name, version => "0" };
185    
186     return mcp_stdio (%kv)
187     if $ENV{PERL_ANYEVENT_MCP_MULTIBROKER_PROTOCOL} eq "stdio";
188    
189     my $global = AnyEvent::MCP::Config->global;
190    
191     %kv = (
192     path => "/",
193 root 1.3 $global->http_settings ($name, delete $kv{bind}),
194 root 1.1 %kv,
195     );
196    
197 root 1.4 mcp_http (%kv)
198 root 1.1 }
199    
200     sub mcp_stdio {
201     require AnyEvent::MCP::Server::JSONL;
202    
203     binmode STDIN;
204     binmode STDOUT;
205     my $selected = select STDOUT;
206     $| = 1;
207     select $selected;
208    
209     my $server = AnyEvent::MCP::Server::JSONL->new (toolsets => [$toolset], %config, @_);
210     $server->accept (\*STDIN, \*STDOUT);
211     _run $server
212     }
213    
214     sub mcp_http {
215     require AnyEvent::MCP::Server::HTTP;
216    
217     my $server = AnyEvent::MCP::Server::HTTP->new (toolsets => [$toolset], %config, @_);
218     $server->listen;
219     _run $server
220     }
221    
222     sub _run {
223     my ($server) = @_;
224    
225     my $cv = AnyEvent->condvar;
226     my $stopped;
227     my $stop = sub { $cv->send unless $stopped++ };
228     my $on_close = $server->{on_close};
229     $server->{on_close} = sub {
230     $on_close->(@_) if $on_close;
231     $stop->();
232     };
233    
234     if ($server->isa ("AnyEvent::MCP::Server::JSONL")) {
235     my $on_connection_close = $server->{on_connection_close};
236     $server->{on_connection_close} = sub {
237     $on_connection_close->(@_) if $on_connection_close;
238     $stop->();
239     };
240     }
241    
242     my @signals = map {
243     AnyEvent->signal (signal => $_, cb => sub { $server->close })
244     } qw(INT TERM);
245    
246     my $ok = eval {
247     $server->event (start =>);
248     $cv->recv;
249     1
250     };
251     my $error = $@;
252     $server->close;
253     die $error unless $ok;
254     return
255     }
256    
257     1