Skip to content

Commit b38d652

Browse files
Auto update docs
1 parent c8bb226 commit b38d652

98 files changed

Lines changed: 4793 additions & 4586 deletions

File tree

Some content is hidden

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

MeshLib/dev/html/C/search/all.js

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

MeshLib/dev/html/Cpp/MRMcpCommon_8h_source.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -171,7 +171,7 @@
171171
<div class="ttc" id="agroup__GeneralGroup_html_ga0280b00dcc1ca26b3e93e6321da0598a"><div class="ttname"><a href="group__GeneralGroup.html#ga0280b00dcc1ca26b3e93e6321da0598a">MR::Mcp::resolveId</a></div><div class="ttdeci">Expected&lt; std::shared_ptr&lt; Object &gt; &gt; resolveId(uint64_t id)</div></div>
172172
<div class="ttc" id="agroup__GeneralGroup_html_ga0c165bcc8653a7af45f1680f2ed83811"><div class="ttname"><a href="group__GeneralGroup.html#ga0c165bcc8653a7af45f1680f2ed83811">MR::Mcp::idOf</a></div><div class="ttdeci">uint64_t idOf(const Object *obj)</div><div class="ttdoc">Pointer -&gt; id (as a JSON number). Matches the ##&lt;id&gt; suffix in ImGui labels for the same object.</div></div>
173173
<div class="ttc" id="agroup__GeneralGroup_html_ga6d7483b6adbc485e9c9b52eb09cb7735"><div class="ttname"><a href="group__GeneralGroup.html#ga6d7483b6adbc485e9c9b52eb09cb7735">MR::Expected</a></div><div class="ttdeci">tl::expected&lt; T, E &gt; Expected</div><div class="ttdef"><b>Definition</b> MRExpected.h:31</div></div>
174-
<div class="ttc" id="anamespaceMR_1_1Mcp_html"><div class="ttname"><a href="namespaceMR_1_1Mcp.html">MR::Mcp</a></div><div class="ttdef"><b>Definition</b> MRMcp.h:11</div></div>
174+
<div class="ttc" id="anamespaceMR_1_1Mcp_html"><div class="ttname"><a href="namespaceMR_1_1Mcp.html">MR::Mcp</a></div><div class="ttdef"><b>Definition</b> MRMcp.h:13</div></div>
175175
<div class="ttc" id="anamespaceMR_html"><div class="ttname"><a href="namespaceMR.html">MR</a></div><div class="ttdoc">only for bindings generation</div><div class="ttdef"><b>Definition</b> MRCameraOrientationPlugin.h:8</div></div>
176176
</div><!-- fragment --></div><!-- contents -->
177177
</div><!-- doc-content -->

MeshLib/dev/html/Cpp/MRMcp_8h.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -145,6 +145,7 @@
145145
</div><!--header-->
146146
<div class="contents">
147147
<div class="textblock"><code>#include &quot;exports.h&quot;</code><br />
148+
<code>#include &quot;<a class="el" href="MRExpected_8h_source.html">MRMesh/MRExpected.h</a>&quot;</code><br />
148149
<code>#include &lt;nlohmann/json.hpp&gt;</code><br />
149150
<code>#include &lt;memory&gt;</code><br />
150151
<code>#include &lt;utility&gt;</code><br />

MeshLib/dev/html/Cpp/MRMcp_8h_source.html

Lines changed: 192 additions & 184 deletions
Large diffs are not rendered by default.

MeshLib/dev/html/Cpp/classMR_1_1Mcp_1_1Server-members.html

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,9 @@
151151
<tr class="odd"><td class="entry"><a class="el" href="classMR_1_1Mcp_1_1Server.html#a21adb00773f87573f304159088264091">Server</a>(Server &amp;&amp;)</td><td class="entry"><a class="el" href="classMR_1_1Mcp_1_1Server.html">MR::Mcp::Server</a></td><td class="entry"></td></tr>
152152
<tr class="even"><td class="entry"><a class="el" href="classMR_1_1Mcp_1_1Server.html#a1cf74440a5bc6fd9f0ec9d45e2cc9eed">setParams</a>(Params params)</td><td class="entry"><a class="el" href="classMR_1_1Mcp_1_1Server.html">MR::Mcp::Server</a></td><td class="entry"></td></tr>
153153
<tr class="odd"><td class="entry"><a class="el" href="classMR_1_1Mcp_1_1Server.html#ae6008d565f2f5a971a3694f196f7ebe9">setRunning</a>(bool enable)</td><td class="entry"><a class="el" href="classMR_1_1Mcp_1_1Server.html">MR::Mcp::Server</a></td><td class="entry"></td></tr>
154-
<tr class="even"><td class="entry"><a class="el" href="classMR_1_1Mcp_1_1Server.html#a164bc1306aece3be615549925d7c373e">ToolFunc</a> typedef</td><td class="entry"><a class="el" href="classMR_1_1Mcp_1_1Server.html">MR::Mcp::Server</a></td><td class="entry"></td></tr>
154+
<tr class="even"><td class="entry"><a class="el" href="classMR_1_1Mcp_1_1Server.html#a41d913fae94d9444c77104e52f2a2200">setToolValidator</a>(ToolValidator validator)</td><td class="entry"><a class="el" href="classMR_1_1Mcp_1_1Server.html">MR::Mcp::Server</a></td><td class="entry"></td></tr>
155+
<tr class="odd"><td class="entry"><a class="el" href="classMR_1_1Mcp_1_1Server.html#a164bc1306aece3be615549925d7c373e">ToolFunc</a> typedef</td><td class="entry"><a class="el" href="classMR_1_1Mcp_1_1Server.html">MR::Mcp::Server</a></td><td class="entry"></td></tr>
156+
<tr class="even"><td class="entry"><a class="el" href="classMR_1_1Mcp_1_1Server.html#a2f9caba495b9ba403409681a6d39c602">ToolValidator</a> typedef</td><td class="entry"><a class="el" href="classMR_1_1Mcp_1_1Server.html">MR::Mcp::Server</a></td><td class="entry"></td></tr>
155157
<tr class="odd"><td class="entry"><a class="el" href="classMR_1_1Mcp_1_1Server.html#a650af3bd0595e9dbd5c6d93d8399688e">~Server</a>()</td><td class="entry"><a class="el" href="classMR_1_1Mcp_1_1Server.html">MR::Mcp::Server</a></td><td class="entry"></td></tr>
156158
</table></div><!-- contents -->
157159
</div><!-- doc-content -->

MeshLib/dev/html/Cpp/classMR_1_1Mcp_1_1Server.html

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -159,6 +159,7 @@
159159
Public Types</h2></td></tr>
160160
<tr class="memitem:a164bc1306aece3be615549925d7c373e" id="r_a164bc1306aece3be615549925d7c373e"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a164bc1306aece3be615549925d7c373e">ToolFunc</a> = std::function&lt;nlohmann::json( const nlohmann::json&amp; args )&gt;</td></tr>
161161
<tr class="memdesc:a164bc1306aece3be615549925d7c373e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Those functions are allowed to throw, that's how you report errors to the MCP. <br /></td></tr>
162+
<tr class="memitem:a2f9caba495b9ba403409681a6d39c602" id="r_a2f9caba495b9ba403409681a6d39c602"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a2f9caba495b9ba403409681a6d39c602">ToolValidator</a> = std::function&lt;<a class="el" href="group__GeneralGroup.html#ga6d7483b6adbc485e9c9b52eb09cb7735">Expected</a>&lt;void&gt;( const std::string&amp; toolId )&gt;</td></tr>
162163
</table><table class="memberdecls">
163164
<tr class="heading"><td colspan="2"><h2 id="header-pub-methods" class="groupheader"><a id="pub-methods" name="pub-methods"></a>
164165
Public Member Functions</h2></td></tr>
@@ -172,6 +173,7 @@
172173
<tr class="memdesc:a1cf74440a5bc6fd9f0ec9d45e2cc9eed"><td class="mdescLeft">&#160;</td><td class="mdescRight">This restarts the server if necessary. <br /></td></tr>
173174
<tr class="memitem:aeeedc6adfa01a6470b40aa229a8f6522" id="r_aeeedc6adfa01a6470b40aa229a8f6522"><td class="memItemLeft" align="right" valign="top">MRMCP_API bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aeeedc6adfa01a6470b40aa229a8f6522">isRunning</a> () const</td></tr>
174175
<tr class="memitem:ae6008d565f2f5a971a3694f196f7ebe9" id="r_ae6008d565f2f5a971a3694f196f7ebe9"><td class="memItemLeft" align="right" valign="top">MRMCP_API bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ae6008d565f2f5a971a3694f196f7ebe9">setRunning</a> (bool enable)</td></tr>
176+
<tr class="memitem:a41d913fae94d9444c77104e52f2a2200" id="r_a41d913fae94d9444c77104e52f2a2200"><td class="memItemLeft" align="right" valign="top">MRMCP_API void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a41d913fae94d9444c77104e52f2a2200">setToolValidator</a> (<a class="el" href="#a2f9caba495b9ba403409681a6d39c602">ToolValidator</a> validator)</td></tr>
175177
</table>
176178
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
177179
<div class="textblock"><p>Owns a HTTP MCP server (using the SSE protocol). </p>
@@ -190,6 +192,21 @@ <h2 class="memtitle"><span class="permalink"><a href="#a164bc1306aece3be61554992
190192

191193
<p>Those functions are allowed to throw, that's how you report errors to the MCP. </p>
192194

195+
</div>
196+
</div>
197+
<a id="a2f9caba495b9ba403409681a6d39c602" name="a2f9caba495b9ba403409681a6d39c602"></a>
198+
<h2 class="memtitle"><span class="permalink"><a href="#a2f9caba495b9ba403409681a6d39c602">&#9670;&#160;</a></span>ToolValidator</h2>
199+
200+
<div class="memitem">
201+
<div class="memproto">
202+
<table class="memname">
203+
<tr>
204+
<td class="memname">using <a class="el" href="#a2f9caba495b9ba403409681a6d39c602">MR::Mcp::Server::ToolValidator</a> = std::function&lt;<a class="el" href="group__GeneralGroup.html#ga6d7483b6adbc485e9c9b52eb09cb7735">Expected</a>&lt;void&gt;( const std::string&amp; toolId )&gt;</td>
205+
</tr>
206+
</table>
207+
</div><div class="memdoc">
208+
<p>Optional predicate consulted before every tool dispatch, given the tool's id. Return {} to allow; return <span class="tt">unexpected("reason")</span> to block — the reason surfaces to the MCP client as the tool-call error. Evaluated per call, so changes (e.g. user sign-in) take effect immediately. </p>
209+
193210
</div>
194211
</div>
195212
<a name="doc-constructors" id="doc-constructors"></a><h2 id="header-doc-constructors" class="groupheader">Constructor &amp; Destructor Documentation</h2>
@@ -398,6 +415,23 @@ <h2 class="memtitle"><span class="permalink"><a href="#ae6008d565f2f5a971a3694f1
398415
</div><div class="memdoc">
399416
<p>Returns true on success, including if the server is already running and you're trying to start it again. Stopping always returns true. </p>
400417

418+
</div>
419+
</div>
420+
<a id="a41d913fae94d9444c77104e52f2a2200" name="a41d913fae94d9444c77104e52f2a2200"></a>
421+
<h2 class="memtitle"><span class="permalink"><a href="#a41d913fae94d9444c77104e52f2a2200">&#9670;&#160;</a></span>setToolValidator()</h2>
422+
423+
<div class="memitem">
424+
<div class="memproto">
425+
<table class="memname">
426+
<tr>
427+
<td class="memname">MRMCP_API void MR::Mcp::Server::setToolValidator </td>
428+
<td>(</td>
429+
<td class="paramtype"><a class="el" href="#a2f9caba495b9ba403409681a6d39c602">ToolValidator</a></td> <td class="paramname"><span class="paramname"><em>validator</em></span></td><td>)</td>
430+
<td></td>
431+
</tr>
432+
</table>
433+
</div><div class="memdoc">
434+
401435
</div>
402436
</div>
403437
<hr/>The documentation for this class was generated from the following file:<ul>

MeshLib/dev/html/Cpp/classMR_1_1Mcp_1_1Server.js

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ var classMR_1_1Mcp_1_1Server =
22
[
33
[ "Params", "structMR_1_1Mcp_1_1Server_1_1Params.html", "structMR_1_1Mcp_1_1Server_1_1Params" ],
44
[ "ToolFunc", "classMR_1_1Mcp_1_1Server.html#a164bc1306aece3be615549925d7c373e", null ],
5+
[ "ToolValidator", "classMR_1_1Mcp_1_1Server.html#a2f9caba495b9ba403409681a6d39c602", null ],
56
[ "Server", "classMR_1_1Mcp_1_1Server.html#a49208ffdadda99d167e31e81d612aeaf", null ],
67
[ "Server", "classMR_1_1Mcp_1_1Server.html#a21adb00773f87573f304159088264091", null ],
78
[ "~Server", "classMR_1_1Mcp_1_1Server.html#a650af3bd0595e9dbd5c6d93d8399688e", null ],
@@ -10,5 +11,6 @@ var classMR_1_1Mcp_1_1Server =
1011
[ "isRunning", "classMR_1_1Mcp_1_1Server.html#aeeedc6adfa01a6470b40aa229a8f6522", null ],
1112
[ "operator=", "classMR_1_1Mcp_1_1Server.html#a385c1838112eca9f739077cd5faa037b", null ],
1213
[ "setParams", "classMR_1_1Mcp_1_1Server.html#a1cf74440a5bc6fd9f0ec9d45e2cc9eed", null ],
13-
[ "setRunning", "classMR_1_1Mcp_1_1Server.html#ae6008d565f2f5a971a3694f196f7ebe9", null ]
14+
[ "setRunning", "classMR_1_1Mcp_1_1Server.html#ae6008d565f2f5a971a3694f196f7ebe9", null ],
15+
[ "setToolValidator", "classMR_1_1Mcp_1_1Server.html#a41d913fae94d9444c77104e52f2a2200", null ]
1416
];

MeshLib/dev/html/Cpp/doxygen_crawl.html

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2357,8 +2357,10 @@
23572357
<a href="classMR_1_1Mcp_1_1Server.html#a164bc1306aece3be615549925d7c373e"/>
23582358
<a href="classMR_1_1Mcp_1_1Server.html#a1cf74440a5bc6fd9f0ec9d45e2cc9eed"/>
23592359
<a href="classMR_1_1Mcp_1_1Server.html#a21adb00773f87573f304159088264091"/>
2360+
<a href="classMR_1_1Mcp_1_1Server.html#a2f9caba495b9ba403409681a6d39c602"/>
23602361
<a href="classMR_1_1Mcp_1_1Server.html#a385c1838112eca9f739077cd5faa037b"/>
23612362
<a href="classMR_1_1Mcp_1_1Server.html#a41546549ccdb8ff6e04c5940af5c450d"/>
2363+
<a href="classMR_1_1Mcp_1_1Server.html#a41d913fae94d9444c77104e52f2a2200"/>
23622364
<a href="classMR_1_1Mcp_1_1Server.html#a49208ffdadda99d167e31e81d612aeaf"/>
23632365
<a href="classMR_1_1Mcp_1_1Server.html#a650af3bd0595e9dbd5c6d93d8399688e"/>
23642366
<a href="classMR_1_1Mcp_1_1Server.html#ae6008d565f2f5a971a3694f196f7ebe9"/>

MeshLib/dev/html/Cpp/functions_func_s.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -522,6 +522,7 @@ <h3 class="doxsection"><a id="index_s" name="index_s"></a>- s -</h3><ul>
522522
<li>setTime()&#160;:&#160;<a class="el" href="group__GeneralGroup.html#gab65fb7589180d52bca903fe8f29a342c">MR::AsyncTimer</a></li>
523523
<li>setTimeIfNotSet()&#160;:&#160;<a class="el" href="group__GeneralGroup.html#ga60543e03cecc827bd61de87a78f48bad">MR::AsyncTimer</a></li>
524524
<li>setTimeout()&#160;:&#160;<a class="el" href="group__GeneralGroup.html#ga4bbb139da99a0e6565bdf13abe5ffc34">MR::WebRequest</a></li>
525+
<li>setToolValidator()&#160;:&#160;<a class="el" href="classMR_1_1Mcp_1_1Server.html#a41d913fae94d9444c77104e52f2a2200">MR::Mcp::Server</a></li>
525526
<li>setTopPanelMaxOpenedTimer()&#160;:&#160;<a class="el" href="group__GeneralGroup.html#ga0b8580dee2b479f1b332f441905c330d">MR::RibbonMenu</a></li>
526527
<li>setTopValue()&#160;:&#160;<a class="el" href="classMR_1_1Heap.html#adb81421ba706699de893596855455c2a">MR::Heap&lt; T, I, P &gt;</a></li>
527528
<li>setTransformMode()&#160;:&#160;<a class="el" href="group__GeneralGroup.html#gaac0fd45e23de3824599f4eaf8998c5f9">MR::ObjectTransformWidget</a></li>

MeshLib/dev/html/Cpp/functions_s.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -592,6 +592,7 @@ <h3 class="doxsection"><a id="index_s" name="index_s"></a>- s -</h3><ul>
592592
<li>setTimeIfNotSet()&#160;:&#160;<a class="el" href="group__GeneralGroup.html#ga60543e03cecc827bd61de87a78f48bad">MR::AsyncTimer</a></li>
593593
<li>setTimeout()&#160;:&#160;<a class="el" href="group__GeneralGroup.html#ga4bbb139da99a0e6565bdf13abe5ffc34">MR::WebRequest</a></li>
594594
<li>settings_&#160;:&#160;<a class="el" href="group__GeneralGroup.html#ga1470ce9a66bc6a7554b36d69c81102e1">MR::SurfaceManipulationWidget</a></li>
595+
<li>setToolValidator()&#160;:&#160;<a class="el" href="classMR_1_1Mcp_1_1Server.html#a41d913fae94d9444c77104e52f2a2200">MR::Mcp::Server</a></li>
595596
<li>setTopPanelMaxOpenedTimer()&#160;:&#160;<a class="el" href="group__GeneralGroup.html#ga0b8580dee2b479f1b332f441905c330d">MR::RibbonMenu</a></li>
596597
<li>setTopValue()&#160;:&#160;<a class="el" href="classMR_1_1Heap.html#adb81421ba706699de893596855455c2a">MR::Heap&lt; T, I, P &gt;</a></li>
597598
<li>setTransformMode()&#160;:&#160;<a class="el" href="group__GeneralGroup.html#gaac0fd45e23de3824599f4eaf8998c5f9">MR::ObjectTransformWidget</a></li>

0 commit comments

Comments
 (0)