Skip to content

Commit f98aa84

Browse files
github-actions[bot]github-actions[bot]
committed
Deploy documentation: snapshot
1 parent 14176a1 commit f98aa84

File tree

352 files changed

+751
-588
lines changed

Some content is hidden

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

352 files changed

+751
-588
lines changed

‎snapshot/advanced.html‎

Lines changed: 77 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -183,6 +183,7 @@ <h2>Table of Contents</h2>
183183
<li><a href="#Compaction_Events">Compaction Events</a></li>
184184
</ul></li>
185185
<li><a href="#MCP_Servers">MCP Servers</a></li>
186+
<li><a href="#Custom_Agents">Custom Agents</a></li>
186187
<li><a href="#Skills_Configuration">Skills Configuration</a>
187188
<ul>
188189

@@ -364,7 +365,82 @@ <h2>MCP Servers</h2>
364365
.setMcpServers(Map.of(&quot;filesystem&quot;, server))
365366
).get();
366367
</code></pre>
367-
<p>&#x1f4d6; <strong><a href="mcp.html">Full MCP documentation &#x2192;</a></strong> for local/remote servers and all options.</p><hr /></section><section><a id="Skills_Configuration"></a>
368+
<p>&#x1f4d6; <strong><a href="mcp.html">Full MCP documentation &#x2192;</a></strong> for local/remote servers and all options.</p><hr /></section><section><a id="Custom_Agents"></a>
369+
<h2>Custom Agents</h2>
370+
<p>Extend the base Copilot assistant with specialized agents that have their own tools, prompts, and behavior. Users can invoke agents using the <code>@agent-name</code> mention syntax in messages.</p>
371+
372+
<pre class="prettyprint"><code class="language-java">var reviewer = new CustomAgentConfig()
373+
.setName(&quot;code-reviewer&quot;)
374+
.setDisplayName(&quot;Code Reviewer&quot;)
375+
.setDescription(&quot;Reviews code for best practices and security&quot;)
376+
.setPrompt(&quot;You are a code review expert. Focus on security, performance, and maintainability.&quot;)
377+
.setTools(List.of(&quot;read_file&quot;, &quot;search_code&quot;));
378+
379+
var session = client.createSession(
380+
new SessionConfig()
381+
.setCustomAgents(List.of(reviewer))
382+
).get();
383+
384+
// The user can now mention @code-reviewer in messages
385+
session.send(&quot;@code-reviewer Review src/Main.java&quot;).get();
386+
</code></pre><section><a id="Configuration_Options"></a>
387+
<h3>Configuration Options</h3>
388+
<table class="table table-striped">
389+
<thead>
390+
<tr class="a">
391+
<th>Option</th>
392+
<th>Type</th>
393+
<th>Description</th></tr></thead><tbody>
394+
<tr class="b">
395+
<td><code>name</code></td>
396+
<td>String</td>
397+
<td>Unique identifier used for <code>@mentions</code> (alphanumeric and hyphens)</td></tr>
398+
<tr class="a">
399+
<td><code>displayName</code></td>
400+
<td>String</td>
401+
<td>Human-readable name shown to users</td></tr>
402+
<tr class="b">
403+
<td><code>description</code></td>
404+
<td>String</td>
405+
<td>Describes the agent's capabilities</td></tr>
406+
<tr class="a">
407+
<td><code>prompt</code></td>
408+
<td>String</td>
409+
<td>System prompt that defines the agent's behavior</td></tr>
410+
<tr class="b">
411+
<td><code>tools</code></td>
412+
<td>List&lt;String&gt;</td>
413+
<td>Tool names available to this agent</td></tr>
414+
<tr class="a">
415+
<td><code>mcpServers</code></td>
416+
<td>Map</td>
417+
<td>MCP servers available to this agent</td></tr>
418+
<tr class="b">
419+
<td><code>infer</code></td>
420+
<td>Boolean</td>
421+
<td>Whether the agent can be auto-selected based on context</td></tr></tbody>
422+
</table>
423+
</section><section><a id="Multiple_Agents"></a>
424+
<h3>Multiple Agents</h3>
425+
<p>Register multiple agents for different tasks:</p>
426+
427+
<pre class="prettyprint"><code class="language-java">var agents = List.of(
428+
new CustomAgentConfig()
429+
.setName(&quot;reviewer&quot;)
430+
.setDescription(&quot;Code review&quot;)
431+
.setPrompt(&quot;You review code for issues.&quot;),
432+
new CustomAgentConfig()
433+
.setName(&quot;documenter&quot;)
434+
.setDescription(&quot;Documentation writer&quot;)
435+
.setPrompt(&quot;You write clear documentation.&quot;)
436+
.setInfer(true) // Auto-select when appropriate
437+
);
438+
439+
var session = client.createSession(
440+
new SessionConfig().setCustomAgents(agents)
441+
).get();
442+
</code></pre>
443+
<p>See <a href="apidocs/com/github/copilot/sdk/json/CustomAgentConfig.html">CustomAgentConfig</a> Javadoc for full details.</p><hr /></section></section><section><a id="Skills_Configuration"></a>
368444
<h2>Skills Configuration</h2>
369445
<p>Load custom skills from directories to extend the AI's capabilities with domain-specific knowledge.</p><section><a id="Loading_Skills"></a>
370446
<h3>Loading Skills</h3>

‎snapshot/apidocs/allclasses-index.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<!DOCTYPE HTML>
22
<html lang>
33
<head>
4-
<!-- Generated by javadoc (17) on Wed Feb 11 05:44:56 UTC 2026 -->
4+
<!-- Generated by javadoc (17) on Wed Feb 11 05:50:14 UTC 2026 -->
55
<title>All Classes and Interfaces (GitHub Copilot Community SDK :: Java 1.0.9-SNAPSHOT API)</title>
66
<meta name="viewport" content="width=device-width, initial-scale=1">
77
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">

‎snapshot/apidocs/allpackages-index.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<!DOCTYPE HTML>
22
<html lang>
33
<head>
4-
<!-- Generated by javadoc (17) on Wed Feb 11 05:44:56 UTC 2026 -->
4+
<!-- Generated by javadoc (17) on Wed Feb 11 05:50:14 UTC 2026 -->
55
<title>All Packages (GitHub Copilot Community SDK :: Java 1.0.9-SNAPSHOT API)</title>
66
<meta name="viewport" content="width=device-width, initial-scale=1">
77
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">

‎snapshot/apidocs/com/github/copilot/sdk/ConnectionState.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<!DOCTYPE HTML>
22
<html lang>
33
<head>
4-
<!-- Generated by javadoc (17) on Wed Feb 11 05:44:56 UTC 2026 -->
4+
<!-- Generated by javadoc (17) on Wed Feb 11 05:50:14 UTC 2026 -->
55
<title>ConnectionState (GitHub Copilot Community SDK :: Java 1.0.9-SNAPSHOT API)</title>
66
<meta name="viewport" content="width=device-width, initial-scale=1">
77
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">

‎snapshot/apidocs/com/github/copilot/sdk/CopilotClient.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<!DOCTYPE HTML>
22
<html lang>
33
<head>
4-
<!-- Generated by javadoc (17) on Wed Feb 11 05:44:56 UTC 2026 -->
4+
<!-- Generated by javadoc (17) on Wed Feb 11 05:50:14 UTC 2026 -->
55
<title>CopilotClient (GitHub Copilot Community SDK :: Java 1.0.9-SNAPSHOT API)</title>
66
<meta name="viewport" content="width=device-width, initial-scale=1">
77
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">

‎snapshot/apidocs/com/github/copilot/sdk/CopilotSession.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<!DOCTYPE HTML>
22
<html lang>
33
<head>
4-
<!-- Generated by javadoc (17) on Wed Feb 11 05:44:56 UTC 2026 -->
4+
<!-- Generated by javadoc (17) on Wed Feb 11 05:50:14 UTC 2026 -->
55
<title>CopilotSession (GitHub Copilot Community SDK :: Java 1.0.9-SNAPSHOT API)</title>
66
<meta name="viewport" content="width=device-width, initial-scale=1">
77
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">

‎snapshot/apidocs/com/github/copilot/sdk/EventErrorHandler.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<!DOCTYPE HTML>
22
<html lang>
33
<head>
4-
<!-- Generated by javadoc (17) on Wed Feb 11 05:44:56 UTC 2026 -->
4+
<!-- Generated by javadoc (17) on Wed Feb 11 05:50:14 UTC 2026 -->
55
<title>EventErrorHandler (GitHub Copilot Community SDK :: Java 1.0.9-SNAPSHOT API)</title>
66
<meta name="viewport" content="width=device-width, initial-scale=1">
77
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">

‎snapshot/apidocs/com/github/copilot/sdk/EventErrorPolicy.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<!DOCTYPE HTML>
22
<html lang>
33
<head>
4-
<!-- Generated by javadoc (17) on Wed Feb 11 05:44:56 UTC 2026 -->
4+
<!-- Generated by javadoc (17) on Wed Feb 11 05:50:14 UTC 2026 -->
55
<title>EventErrorPolicy (GitHub Copilot Community SDK :: Java 1.0.9-SNAPSHOT API)</title>
66
<meta name="viewport" content="width=device-width, initial-scale=1">
77
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">

‎snapshot/apidocs/com/github/copilot/sdk/SdkProtocolVersion.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<!DOCTYPE HTML>
22
<html lang>
33
<head>
4-
<!-- Generated by javadoc (17) on Wed Feb 11 05:44:56 UTC 2026 -->
4+
<!-- Generated by javadoc (17) on Wed Feb 11 05:50:14 UTC 2026 -->
55
<title>SdkProtocolVersion (GitHub Copilot Community SDK :: Java 1.0.9-SNAPSHOT API)</title>
66
<meta name="viewport" content="width=device-width, initial-scale=1">
77
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">

‎snapshot/apidocs/com/github/copilot/sdk/SystemMessageMode.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<!DOCTYPE HTML>
22
<html lang>
33
<head>
4-
<!-- Generated by javadoc (17) on Wed Feb 11 05:44:56 UTC 2026 -->
4+
<!-- Generated by javadoc (17) on Wed Feb 11 05:50:14 UTC 2026 -->
55
<title>SystemMessageMode (GitHub Copilot Community SDK :: Java 1.0.9-SNAPSHOT API)</title>
66
<meta name="viewport" content="width=device-width, initial-scale=1">
77
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">

0 commit comments

Comments
 (0)