* Change package name * Update publication * Update docs * Update settings.gradle.kts, README and CONTRIBUTING * Cleanup leftovers
87 lines
No EOL
8.6 KiB
HTML
87 lines
No EOL
8.6 KiB
HTML
<!DOCTYPE html>
|
|
<html class="no-js">
|
|
<head>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
|
|
<title>mcpWebSocketTransport</title>
|
|
<link href="../../images/logo-icon.svg" rel="icon" type="image/svg">
|
|
<script>var pathToRoot = "../../";</script>
|
|
<script>document.documentElement.classList.replace("no-js","js");</script>
|
|
<script>const storage = localStorage.getItem("dokka-dark-mode")
|
|
if (storage == null) {
|
|
const osDarkSchemePreferred = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches
|
|
if (osDarkSchemePreferred === true) {
|
|
document.getElementsByTagName("html")[0].classList.add("theme-dark")
|
|
}
|
|
} else {
|
|
const savedDarkMode = JSON.parse(storage)
|
|
if(savedDarkMode === true) {
|
|
document.getElementsByTagName("html")[0].classList.add("theme-dark")
|
|
}
|
|
}
|
|
</script>
|
|
<script type="text/javascript" src="https://unpkg.com/kotlin-playground@1/dist/playground.min.js" async="async"></script>
|
|
<script type="text/javascript" src="../../scripts/sourceset_dependencies.js" async="async"></script>
|
|
<link href="../../styles/style.css" rel="Stylesheet">
|
|
<link href="../../styles/main.css" rel="Stylesheet">
|
|
<link href="../../styles/prism.css" rel="Stylesheet">
|
|
<link href="../../styles/logo-styles.css" rel="Stylesheet">
|
|
<link href="../../styles/font-jb-sans-auto.css" rel="Stylesheet">
|
|
<link href="../../ui-kit/ui-kit.min.css" rel="Stylesheet">
|
|
<script type="text/javascript" src="../../scripts/clipboard.js" async="async"></script>
|
|
<script type="text/javascript" src="../../scripts/navigation-loader.js" async="async"></script>
|
|
<script type="text/javascript" src="../../scripts/platform-content-handler.js" async="async"></script>
|
|
<script type="text/javascript" src="../../scripts/main.js" defer="defer"></script>
|
|
<script type="text/javascript" src="../../scripts/prism.js" async="async"></script>
|
|
<script type="text/javascript" src="../../ui-kit/ui-kit.min.js" async="async"></script>
|
|
<script type="text/javascript" src="../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
|
|
</head>
|
|
<body>
|
|
<div class="root">
|
|
<nav class="navigation" id="navigation-wrapper">
|
|
<div class="navigation--inner">
|
|
<div class="navigation-title">
|
|
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
|
|
<div class="library-name">
|
|
<a class="library-name--link" href="../../index.html">
|
|
MCP Kotlin SDK
|
|
</a>
|
|
</div>
|
|
<div class="library-version">
|
|
0.1.0 </div>
|
|
</div>
|
|
<div class="filter-section" id="filter-section">
|
|
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":/main">jvm</button>
|
|
</div>
|
|
</div>
|
|
<div class="navigation-controls">
|
|
<button class="navigation-controls--btn navigation-controls--theme" id="theme-toggle-button" type="button">switch theme</button>
|
|
<div class="navigation-controls--btn navigation-controls--search" id="searchBar" role="button">search in API</div>
|
|
</div>
|
|
</nav>
|
|
<div id="container">
|
|
<div class="sidebar" id="leftColumn">
|
|
<div class="sidebar--inner" id="sideMenu"></div>
|
|
</div>
|
|
<div id="main">
|
|
<div class="main-content" data-page-type="member" id="content" pageIds="MCP Kotlin SDK::io.modelcontextprotocol.kotlin.sdk.server//mcpWebSocketTransport/io.ktor.server.routing.Route#kotlin.coroutines.SuspendFunction1[io.modelcontextprotocol.kotlin.sdk.server.WebSocketMcpServerTransport,kotlin.Unit]/PointingToDeclaration//-251573632">
|
|
<div class="breadcrumbs"><a href="../../index.html">MCP Kotlin SDK</a><span class="delimiter">/</span><a href="index.html">io.modelcontextprotocol.kotlin.sdk.server</a><span class="delimiter">/</span><span class="current">mcpWebSocketTransport</span></div>
|
|
<div class="cover ">
|
|
<h1 class="cover"><span>mcp</span><wbr></wbr><span>Web</span><wbr></wbr><span>Socket</span><wbr></wbr><span><span>Transport</span></span></h1>
|
|
</div>
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":/main"><div class="symbol monospace"><span class="token keyword">fun </span><span data-unresolved-link="io.ktor.server.routing/Route///PointingToDeclaration/">Route</span><span class="token punctuation">.</span><a href="mcp-web-socket-transport.html"><span class="token function">mcpWebSocketTransport</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">handler<span class="token operator">: </span><span class="token keyword">suspend </span><a href="-web-socket-mcp-server-transport/index.html">WebSocketMcpServerTransport</a><span class="token punctuation">.</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator"> -> </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html">Unit</a><span class="token operator"> = </span>{}</span></span><span class="token punctuation">)</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/modelcontextprotocol/kotlin-sdk/io/modelcontextprotocol/kotlin/sdk/server/WebSocketMcpKtorServerExtensions.kt#L47">source</a>)</span></span></div><p class="paragraph">Registers a WebSocket route that creates an MCP server transport layer.</p><h4 class="">Parameters</h4><div class="table"><div class="table-row" data-filterable-current=":/main" data-filterable-set=":/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span><span>handler</span></span></u></div></span></div><div><div class="title"><p class="paragraph">A suspend function that defines the behavior of the transport layer.</p></div></div></div></div></div><hr><div class="symbol monospace"><span class="token keyword">fun </span><span data-unresolved-link="io.ktor.server.routing/Route///PointingToDeclaration/">Route</span><span class="token punctuation">.</span><a href="mcp-web-socket-transport.html"><span class="token function">mcpWebSocketTransport</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">path<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">, </span></span><span class="parameter ">handler<span class="token operator">: </span><span class="token keyword">suspend </span><a href="-web-socket-mcp-server-transport/index.html">WebSocketMcpServerTransport</a><span class="token punctuation">.</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator"> -> </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html">Unit</a><span class="token operator"> = </span>{}</span></span><span class="token punctuation">)</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/modelcontextprotocol/kotlin-sdk/io/modelcontextprotocol/kotlin/sdk/server/WebSocketMcpKtorServerExtensions.kt#L64">source</a>)</span></span></div><p class="paragraph">Registers a WebSocket route at the specified <a href="mcp-web-socket-transport.html">path</a> that creates an MCP server transport layer.</p><h4 class="">Parameters</h4><div class="table"><div class="table-row" data-filterable-current=":/main" data-filterable-set=":/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span><span>path</span></span></u></div></span></div><div><div class="title"><p class="paragraph">The URL path at which to register the WebSocket route.</p></div></div></div></div><div class="table-row" data-filterable-current=":/main" data-filterable-set=":/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span><span>handler</span></span></u></div></span></div><div><div class="title"><p class="paragraph">A suspend function that defines the behavior of the transport layer.</p></div></div></div></div></div></div></div>
|
|
</div>
|
|
<div class="footer">
|
|
<a href="#content" id="go-to-top-link" class="footer--button footer--button_go-to-top"></a>
|
|
<span>© 2024 Copyright</span>
|
|
<span class="pull-right">
|
|
<span>Generated by </span>
|
|
<a class="footer--link footer--link_external" href="https://github.com/Kotlin/dokka">
|
|
<span>dokka</span>
|
|
</a>
|
|
</span>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html> |