-
Notifications
You must be signed in to change notification settings - Fork 7
Expand file tree
/
Copy pathmcp.html
More file actions
344 lines (330 loc) · 15.5 KB
/
Copy pathmcp.html
File metadata and controls
344 lines (330 loc) · 15.5 KB
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
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
<!DOCTYPE html>
<!--
| Generated by Apache Maven Doxia Site Renderer 2.0.0 from target/filtered-site/markdown/mcp.md at 2026-04-26
| Rendered using Apache Maven Fluido Skin 2.1.0
-->
<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="generator" content="Apache Maven Doxia Site Renderer 2.0.0" />
<title>MCP Servers – GitHub Copilot SDK :: Java</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-2.1.0.min.css" />
<link rel="stylesheet" href="./css/site.css" />
<link rel="stylesheet" href="./css/print.css" media="print" />
<script src="./js/apache-maven-fluido-2.1.0.min.js"></script>
<style>.github-fork-ribbon:before { background-color: gray; }</style>
</head>
<body class="topBarEnabled">
<a class="github-fork-ribbon right-top" href="https://github.com/github/copilot-sdk-java" data-ribbon="Fork me on GitHub">Fork me on GitHub</a>
<header id="topbar" class="navbar navbar-fixed-top ">
<div class="navbar-inner">
<div class="container-fluid">
<a data-target=".nav-collapse" data-toggle="collapse" class="btn btn-navbar">
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</a>
<a class="brand" href="index.html">GitHub Copilot SDK for Java
</a>
<ul class="nav">
<li class="dropdown">
<a class="dropdown-toggle" data-toggle="dropdown">Overview <b class="caret"></b></a>
<ul class="dropdown-menu">
<li><a href="index.html">Introduction</a></li>
<li><a href="getting-started.html">Getting Started</a></li>
<li><a href="setup.html">Setup</a></li>
<li><a href="documentation.html">Documentation</a></li>
<li><a>MCP Servers</a></li>
<li><a href="hooks.html">Session Hooks</a></li>
<li><a href="advanced.html">Advanced Usage</a></li>
<li><a href="apidocs/index.html">API Javadoc</a></li>
</ul>
</li>
<li class="dropdown">
<a class="dropdown-toggle" data-toggle="dropdown">Guides <b class="caret"></b></a>
<ul class="dropdown-menu">
<li><a href="documentation.html#Basic_Usage">Basic Usage</a></li>
<li><a href="documentation.html#Handling_Responses">Handling Responses</a></li>
<li><a href="documentation.html#Streaming_Responses">Streaming</a></li>
<li><a href="documentation.html#Choosing_a_Model">Choosing a Model</a></li>
<li><a href="documentation.html#Session_Management">Session Management</a></li>
</ul>
</li>
<li class="dropdown">
<a class="dropdown-toggle" data-toggle="dropdown">Advanced <b class="caret"></b></a>
<ul class="dropdown-menu">
<li><a href="advanced.html#Custom_Tools">Custom Tools</a></li>
<li><a href="advanced.html#System_Messages">System Messages</a></li>
<li><a href="advanced.html#File_Attachments">File Attachments</a></li>
<li><a href="advanced.html#Bring_Your_Own_Key_.28BYOK.29">BYOK</a></li>
<li><a href="advanced.html#Infinite_Sessions">Infinite Sessions</a></li>
<li><a href="advanced.html#MCP_Servers">MCP Servers</a></li>
<li><a href="advanced.html#Slash_Commands">Slash Commands</a></li>
<li><a href="advanced.html#Elicitation_UI_Dialogs">Elicitation</a></li>
<li><a href="advanced.html#Getting_Session_Metadata_by_ID">Session Metadata</a></li>
<li><a href="hooks.html">Session Hooks</a></li>
</ul>
</li>
<li class="dropdown">
<a class="dropdown-toggle" data-toggle="dropdown">Cookbook <b class="caret"></b></a>
<ul class="dropdown-menu">
<li><a href="cookbook/README.html">Overview</a></li>
<li><a href="cookbook/error-handling.html">Error Handling</a></li>
<li><a href="cookbook/multiple-sessions.html">Multiple Sessions</a></li>
<li><a href="cookbook/managing-local-files.html">Managing Local Files</a></li>
<li><a href="cookbook/pr-visualization.html">PR Visualization</a></li>
<li><a href="cookbook/persisting-sessions.html">Persisting Sessions</a></li>
</ul>
</li>
<li class="dropdown">
<a class="dropdown-toggle" data-toggle="dropdown">Project Documentation <b class="caret"></b></a>
<ul class="dropdown-menu">
<li class="dropdown-submenu">
<a href="project-info.html">Project Information</a>
<ul class="dropdown-menu">
<li><a href="dependencies.html">Dependencies</a></li>
<li><a href="dependency-info.html">Maven Coordinates</a></li>
<li><a href="distribution-management.html">Distribution Management</a></li>
<li><a href="index.html">About</a></li>
<li><a href="licenses.html">Licenses</a></li>
<li><a href="plugin-management.html">Plugin Management</a></li>
<li><a href="plugins.html">Plugins</a></li>
<li><a href="scm.html">Source Code Management</a></li>
<li><a href="summary.html">Summary</a></li>
<li><a href="team.html">Team</a></li>
</ul>
</li>
<li class="dropdown-submenu">
<a href="project-reports.html">Project Reports</a>
<ul class="dropdown-menu">
<li><a href="apidocs/index.html">Javadoc</a></li>
<li><a href="surefire.html">Surefire</a></li>
<li><a href="spotbugs.html">SpotBugs</a></li>
<li><a href="taglist.html">Tag List</a></li>
<li><a href="dependency-analysis.html">Dependency Analysis</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
</header>
<div class="container-fluid container-fluid-top">
<header>
<div id="banner">
<div class="pull-left"></div>
<div class="pull-right"></div>
<div class="clear"><hr/></div>
</div>
<div id="breadcrumbs">
<ul class="breadcrumb">
<li id="publishDate">Last Published: 2026-04-26<span class="divider">|</span>
</li>
<li id="projectVersion">Version: 0.3.0-java.2<span class="divider">|</span></li>
<li><a href="index.html">Home</a><span class="divider">/</span></li>
<li class="active">MCP Servers</li>
</ul>
</div>
</header>
<div class="row-fluid">
<header id="leftColumn" class="span2">
<nav class="well sidebar-nav">
<ul class="nav nav-list">
<li class="nav-header">Overview</li>
<li><a href="index.html">Introduction</a></li>
<li><a href="getting-started.html">Getting Started</a></li>
<li><a href="setup.html">Setup</a></li>
<li><a href="documentation.html">Documentation</a></li>
<li class="active"><a>MCP Servers</a></li>
<li><a href="hooks.html">Session Hooks</a></li>
<li><a href="advanced.html">Advanced Usage</a></li>
<li><a href="apidocs/index.html">API Javadoc</a></li>
<li class="nav-header">Guides</li>
<li><a href="documentation.html#Basic_Usage">Basic Usage</a></li>
<li><a href="documentation.html#Handling_Responses">Handling Responses</a></li>
<li><a href="documentation.html#Streaming_Responses">Streaming</a></li>
<li><a href="documentation.html#Choosing_a_Model">Choosing a Model</a></li>
<li><a href="documentation.html#Session_Management">Session Management</a></li>
<li class="nav-header">Advanced</li>
<li><a href="advanced.html#Custom_Tools">Custom Tools</a></li>
<li><a href="advanced.html#System_Messages">System Messages</a></li>
<li><a href="advanced.html#File_Attachments">File Attachments</a></li>
<li><a href="advanced.html#Bring_Your_Own_Key_.28BYOK.29">BYOK</a></li>
<li><a href="advanced.html#Infinite_Sessions">Infinite Sessions</a></li>
<li><a href="advanced.html#MCP_Servers">MCP Servers</a></li>
<li><a href="advanced.html#Slash_Commands">Slash Commands</a></li>
<li><a href="advanced.html#Elicitation_UI_Dialogs">Elicitation</a></li>
<li><a href="advanced.html#Getting_Session_Metadata_by_ID">Session Metadata</a></li>
<li><a href="hooks.html">Session Hooks</a></li>
<li class="nav-header">Cookbook</li>
<li><a href="cookbook/README.html">Overview</a></li>
<li><a href="cookbook/error-handling.html">Error Handling</a></li>
<li><a href="cookbook/multiple-sessions.html">Multiple Sessions</a></li>
<li><a href="cookbook/managing-local-files.html">Managing Local Files</a></li>
<li><a href="cookbook/pr-visualization.html">PR Visualization</a></li>
<li><a href="cookbook/persisting-sessions.html">Persisting Sessions</a></li>
<li class="nav-header">Project Documentation</li>
<li><a href="project-info.html"><span class="icon-chevron-right"></span>Project Information</a></li>
<li><a href="project-reports.html"><span class="icon-chevron-right"></span>Project Reports</a></li>
</ul>
</nav>
<div class="well sidebar-nav">
<div id="poweredBy">
<div class="clear"></div>
<div class="clear"></div>
<a href="https://maven.apache.org/" class="builtBy" target="_blank"><img class="builtBy" alt="Built by Maven" src="./images/logos/maven-feather.png" /></a>
</div>
</div>
</header>
<main id="bodyColumn" class="span10">
<section><a id="MCP_Servers"></a>
<h1>MCP Servers</h1>
<p>Extend the AI's capabilities with external tools using the <a href="https://modelcontextprotocol.io/" class="externalLink">Model Context Protocol</a>.</p><hr /><section><a id="Quick_Start"></a>
<h2>Quick Start</h2>
<p>Give the AI access to your filesystem.</p>
<pre class="prettyprint"><code class="language-java">Map<String, Object> server = Map.of(
"type", "local",
"command", "npx",
"args", List.of("-y", "@modelcontextprotocol/server-filesystem", "/tmp"),
"tools", List.of("*")
);
var session = client.createSession(
new SessionConfig().setOnPermissionRequest(PermissionHandler.APPROVE_ALL)
.setMcpServers(Map.of("filesystem", server))
).get();
var result = session.sendAndWait("List files in the directory").get();
System.out.println(result.getData().content());
</code></pre>
<blockquote>
<p><strong>Tip:</strong> Browse the <a href="https://github.com/modelcontextprotocol/servers" class="externalLink">MCP Servers Directory</a> for community servers like GitHub, SQLite, and Puppeteer.</p>
</blockquote><hr /></section><section><a id="Local_Servers"></a>
<h2>Local Servers</h2>
<p>Run a tool as a subprocess (stdin/stdout communication).</p>
<pre class="prettyprint"><code class="language-java">var server = new HashMap<String, Object>();
server.put("type", "local");
server.put("command", "node");
server.put("args", List.of("./mcp-server.js"));
server.put("env", Map.of("DEBUG", "true"));
server.put("cwd", "./servers");
server.put("tools", List.of("*"));
</code></pre>
<table class="table table-striped">
<thead>
<tr class="a">
<th>Option</th>
<th>Description</th></tr></thead><tbody>
<tr class="b">
<td><code>command</code></td>
<td>Executable to run</td></tr>
<tr class="a">
<td><code>args</code></td>
<td>Command-line arguments</td></tr>
<tr class="b">
<td><code>env</code></td>
<td>Environment variables</td></tr>
<tr class="a">
<td><code>cwd</code></td>
<td>Working directory</td></tr>
<tr class="b">
<td><code>tools</code></td>
<td><code>["*"]</code> for all, <code>[]</code> for none, or specific tool names</td></tr>
<tr class="a">
<td><code>timeout</code></td>
<td>Timeout in milliseconds</td></tr></tbody>
</table>
<hr /></section><section><a id="Remote_Servers"></a>
<h2>Remote Servers</h2>
<p>Connect to a cloud-hosted MCP server via HTTP.</p>
<pre class="prettyprint"><code class="language-java">Map<String, Object> server = Map.of(
"type", "http",
"url", "https://api.githubcopilot.com/mcp/",
"headers", Map.of("Authorization", "Bearer " + token),
"tools", List.of("*")
);
</code></pre>
<table class="table table-striped">
<thead>
<tr class="a">
<th>Option</th>
<th>Description</th></tr></thead><tbody>
<tr class="b">
<td><code>type</code></td>
<td><code>"http"</code> or <code>"sse"</code></td></tr>
<tr class="a">
<td><code>url</code></td>
<td>Server endpoint</td></tr>
<tr class="b">
<td><code>headers</code></td>
<td>HTTP headers for authentication</td></tr>
<tr class="a">
<td><code>tools</code></td>
<td>Tools to enable</td></tr>
<tr class="b">
<td><code>timeout</code></td>
<td>Timeout in milliseconds</td></tr></tbody>
</table>
<hr /></section><section><a id="Multiple_Servers"></a>
<h2>Multiple Servers</h2>
<p>Combine tools from several sources.</p>
<pre class="prettyprint"><code class="language-java">var session = client.createSession(
new SessionConfig().setOnPermissionRequest(PermissionHandler.APPROVE_ALL)
.setMcpServers(Map.of(
"filesystem", filesystemServer,
"github", githubServer,
"database", sqliteServer
))
).get();
</code></pre><hr /></section><section><a id="Troubleshooting"></a>
<h2>Troubleshooting</h2>
<table class="table table-striped">
<thead>
<tr class="a">
<th>Problem</th>
<th>Solution</th></tr></thead><tbody>
<tr class="b">
<td>Tools not invoked</td>
<td>Set <code>tools</code> to <code>["*"]</code> or list specific tool names</td></tr>
<tr class="a">
<td>Server not found</td>
<td>Verify <code>command</code> path is correct and executable</td></tr>
<tr class="b">
<td>Connection refused</td>
<td>Check URL and authentication headers</td></tr>
<tr class="a">
<td>Timeout errors</td>
<td>Increase <code>timeout</code> or check server performance</td></tr></tbody>
</table>
<p><strong>Debug tips:</strong></p>
<ul>
<li>Test your MCP server independently before integrating</li>
<li>Enable verbose logging in the server</li>
<li>Start with a simple tool to verify the integration</li>
</ul><hr /></section><section><a id="Resources"></a>
<h2>Resources</h2>
<ul>
<li><a href="https://modelcontextprotocol.io/" class="externalLink">MCP Specification</a></li>
<li><a href="https://github.com/modelcontextprotocol/servers" class="externalLink">MCP Servers Directory</a></li>
<li><a href="https://github.com/github/github-mcp-server" class="externalLink">GitHub MCP Server</a></li>
</ul><hr /></section><section><a id="Next_Steps"></a>
<h2>Next Steps</h2>
<ul>
<li>📖 <strong><a href="documentation.html">Documentation</a></strong> - Core concepts, events, session management</li>
<li>📖 <strong><a href="advanced.html">Advanced Usage</a></strong> - Tools, BYOK, System Messages, Custom Agents</li>
<li>📖 <strong><a href="hooks.html">Session Hooks</a></strong> - Intercept tool execution and session lifecycle events</li>
<li>📖 <strong><a href="apidocs/index.html">API Javadoc</a></strong> - Complete API reference</li>
</ul></section></section> </main>
</div>
</div>
<hr/>
<footer>
<div class="container-fluid">
<div class="row-fluid">
<p>© 2026
</p>
</div>
</div>
</footer>
</body>
</html>