Doxygen MCP Server

Overview Schema Related Servers Score Discussions

server_8py_source.html•102 kB

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml" lang="en-US"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <meta http-equiv="X-UA-Compatible" content="IE=11"/> <meta name="generator" content="Doxygen 1.15.0"/> <meta name="viewport" content="width=device-width, initial-scale=1"/> <title>Doxygen MCP Server: D:/dev/ARTIFICIAL_INTELLIGENCE/MCP/doxygen-mcp/src/doxygen_mcp/server.py Source File</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> <script type="text/javascript" src="clipboard.js"></script> <link href="navtree.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="navtreedata.js"></script> <script type="text/javascript" src="navtree.js"></script> <script type="text/javascript" src="cookie.js"></script> <link href="search/search.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="search/searchdata.js"></script> <script type="text/javascript" src="search/search.js"></script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> <div id="top"> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr id="projectrow"> <td id="projectalign"> <div id="projectname">Doxygen MCP Server </div> </td> </tr> </tbody> </table> </div>   <script type="text/javascript"> var searchBox = new SearchBox("searchBox", "search/",'.html'); </script> <script type="text/javascript"> $(function() { codefold.init(); }); </script> <script type="text/javascript" src="menudata.js"></script> <script type="text/javascript" src="menu.js"></script> <script type="text/javascript"> $(function() { initMenu('',true,false,'search.php','Search',true); $(function() { init_search(); }); }); </script> <div id="main-nav"></div> </div> <div id="side-nav" class="ui-resizable side-nav-resizable"> <div id="nav-tree"> <div id="nav-tree-contents"> <div id="nav-sync" class="sync"></div> </div> </div> <div id="splitbar" style="-moz-user-select:none;" class="ui-resizable-handle"> </div> </div> <script type="text/javascript"> $(function(){initNavTree('server_8py_source.html','',''); }); </script> <div id="container"> <div id="doc-content">  <div id="MSearchSelectWindow" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" onkeydown="return searchBox.OnSearchSelectKey(event)"> </div>  <div id="MSearchResultsWindow"> <div id="MSearchResults"> <div class="SRPage"> <div id="SRIndex"> <div id="SRResults"></div> <div class="SRStatus" id="Loading">Loading...</div> <div class="SRStatus" id="Searching">Searching...</div> <div class="SRStatus" id="NoMatches">No Matches</div> </div> </div> </div> </div> <div class="header"> <div class="headertitle"><div class="title">server.py</div></div> </div> <div class="contents"> <a href="server_8py.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"><a class="line" href="namespacedoxygen__mcp_1_1server.html"> 1</a></span><span class="comment">#!/usr/bin/env python3</span></div> <div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="stringliteral">"""</span></div> <div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="stringliteral">Doxygen MCP Server</span></div> <div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="stringliteral"></span> </div> <div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="stringliteral">A comprehensive Model Context Protocol server that provides full access to Doxygen's </span></div> <div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="stringliteral">documentation generation capabilities. This server exposes Doxygen's complete feature </span></div> <div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="stringliteral">set through a clean MCP interface, enabling AI assistants to generate, configure, </span></div> <div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="stringliteral">and manage documentation for any supported programming language.</span></div> <div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="stringliteral"></span> </div> <div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="stringliteral">Supported Languages:</span></div> <div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="stringliteral">- Primary: C, C++, Python, PHP</span></div> <div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="stringliteral">- Extended: Java, C#, JavaScript, Objective-C, Fortran, VHDL</span></div> <div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="stringliteral">- Additional: Batch, PowerShell, Bash, Perl, Go (through extension mapping)</span></div> <div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="stringliteral"></span> </div> <div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="stringliteral">Key Features:</span></div> <div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="stringliteral">- Project initialization and configuration management</span></div> <div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="stringliteral">- Multi-format output generation (HTML, PDF, LaTeX, XML, etc.)</span></div> <div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="stringliteral">- Advanced diagram generation (UML, call graphs, inheritance diagrams)</span></div> <div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span><span class="stringliteral">- Documentation coverage analysis and validation</span></div> <div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="stringliteral">- Cross-referencing and link generation</span></div> <div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="stringliteral">- Custom theme and layout support</span></div> <div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span><span class="stringliteral">"""</span></div> <div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> </div> <div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="keyword">import</span> asyncio</div> <div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="keyword">import</span> json</div> <div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span><span class="keyword">import</span> logging</div> <div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><span class="keyword">import</span> os</div> <div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span><span class="keyword">import</span> subprocess</div> <div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span><span class="keyword">import</span> tempfile</div> <div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span><span class="keyword">import</span> xml.etree.ElementTree <span class="keyword">as</span> ET</div> <div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span><span class="keyword">from</span> pathlib <span class="keyword">import</span> Path</div> <div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span><span class="keyword">from</span> typing <span class="keyword">import</span> Any, Dict, List, Optional, Sequence, Union</div> <div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span><span class="keyword">import</span> shutil</div> <div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span><span class="keyword">import</span> re</div> <div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> </div> <div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span><span class="comment"># MCP server imports</span></div> <div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span><span class="keyword">from</span> mcp.server.fastmcp <span class="keyword">import</span> FastMCP</div> <div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span><span class="keyword">from</span> mcp.types <span class="keyword">import</span> (</div> <div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> TextContent,</div> <div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span>)</div> <div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span><span class="keyword">from</span> pydantic <span class="keyword">import</span> BaseModel</div> <div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> </div> <div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span><span class="comment"># Configure logging</span></div> <div class="line"><a id="l00044" name="l00044"></a><span class="lineno"><a class="line" href="namespacedoxygen__mcp_1_1server.html#a2ee9b13cd0a6ff06a596e07b4f338a12"> 44</a></span>logging.basicConfig(level=logging.INFO)</div> <div class="line"><a id="l00045" name="l00045"></a><span class="lineno"><a class="line" href="namespacedoxygen__mcp_1_1server.html#a93f1b823888b5aa1e90f901e2ecf89cc"> 45</a></span>logger = logging.getLogger(<span class="stringliteral">"doxygen-mcp"</span>)</div> <div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> </div> <div class="line"><a id="l00047" name="l00047"></a><span class="lineno"><a class="line" href="namespacedoxygen__mcp_1_1server.html#a1ba7fd448d6058b759c529cf472320aa"> 47</a></span>mcp = FastMCP(<span class="stringliteral">"Doxygen"</span>)</div> <div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> </div> <div class="foldopen" id="foldopen00049" data-start="" data-end=""> <div class="line"><a id="l00049" name="l00049"></a><span class="lineno"><a class="line" href="classdoxygen__mcp_1_1server_1_1_doxygen_config.html"> 49</a></span><span class="keyword">class </span><a class="code hl_class" href="classdoxygen__mcp_1_1server_1_1_doxygen_config.html">DoxygenConfig</a>(BaseModel):</div> <div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> <span class="stringliteral">"""</span></div> <div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span><span class="stringliteral"> @brief Represents a Doxygen configuration with all major options</span></div> <div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span><span class="stringliteral"> </span></div> <div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span><span class="stringliteral"> This class encapsulates all the major configuration options available in Doxygen,</span></div> <div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span><span class="stringliteral"> providing a structured way to manage documentation generation settings. It supports</span></div> <div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span><span class="stringliteral"> multiple programming languages, output formats, and advanced features like diagram</span></div> <div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span><span class="stringliteral"> generation and source browsing.</span></div> <div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span><span class="stringliteral"> </span></div> <div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span><span class="stringliteral"> @details The configuration is designed to be language-agnostic while providing</span></div> <div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span><span class="stringliteral"> specific optimizations for different programming languages. It can generate</span></div> <div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span><span class="stringliteral"> Doxyfile content that is compatible with Doxygen 1.9.0 and later.</span></div> <div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span><span class="stringliteral"> </span></div> <div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span><span class="stringliteral"> @example</span></div> <div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span><span class="stringliteral"> @code{.py}</span></div> <div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span><span class="stringliteral"> config = DoxygenConfig(</span></div> <div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span><span class="stringliteral"> project_name="My API Documentation",</span></div> <div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span><span class="stringliteral"> output_directory="./docs",</span></div> <div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span><span class="stringliteral"> file_patterns=["*.cpp", "*.h"],</span></div> <div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span><span class="stringliteral"> extract_private=False</span></div> <div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span><span class="stringliteral"> )</span></div> <div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span><span class="stringliteral"> doxyfile_content = config.to_doxyfile()</span></div> <div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span><span class="stringliteral"> @endcode</span></div> <div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span><span class="stringliteral"> """</span></div> <div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span> </div> <div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span> <span class="comment"># Project settings</span></div> <div class="line"><a id="l00075" name="l00075"></a><span class="lineno"><a class="line" href="classdoxygen__mcp_1_1server_1_1_doxygen_config.html#af49e8ac6d6c7d2adbf45dc833fadcb7f"> 75</a></span> project_name: str = <span class="stringliteral">"My Project"</span></div> <div class="line"><a id="l00076" name="l00076"></a><span class="lineno"><a class="line" href="classdoxygen__mcp_1_1server_1_1_doxygen_config.html#ad92a95a744ba1e8adec9a74f90ed38d4"> 76</a></span> project_number: str = <span class="stringliteral">""</span></div> <div class="line"><a id="l00077" name="l00077"></a><span class="lineno"><a class="line" href="classdoxygen__mcp_1_1server_1_1_doxygen_config.html#a18f221d8e7f1635c50392718aca9819a"> 77</a></span> project_brief: str = <span class="stringliteral">""</span></div> <div class="line"><a id="l00078" name="l00078"></a><span class="lineno"><a class="line" href="classdoxygen__mcp_1_1server_1_1_doxygen_config.html#a6d5c1f27645615b0b802169b8117cc6d"> 78</a></span> project_logo: str = <span class="stringliteral">""</span></div> <div class="line"><a id="l00079" name="l00079"></a><span class="lineno"><a class="line" href="classdoxygen__mcp_1_1server_1_1_doxygen_config.html#add8b9a5cb1721afed45042ee252de95a"> 79</a></span> output_directory: str = <span class="stringliteral">"./docs"</span></div> <div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span> </div> <div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span> <span class="comment"># Input settings</span></div> <div class="line"><a id="l00082" name="l00082"></a><span class="lineno"><a class="line" href="classdoxygen__mcp_1_1server_1_1_doxygen_config.html#a77347acdf6676826473475c131ffdda8"> 82</a></span> input_paths: List[str] = [<span class="stringliteral">"."</span>]</div> <div class="line"><a id="l00083" name="l00083"></a><span class="lineno"><a class="line" href="classdoxygen__mcp_1_1server_1_1_doxygen_config.html#a8bfb354e5d8280ac98250caa9fa894b5"> 83</a></span> file_patterns: List[str] = [<span class="stringliteral">"*.c"</span>, <span class="stringliteral">"*.cpp"</span>, <span class="stringliteral">"*.h"</span>, <span class="stringliteral">"*.hpp"</span>, <span class="stringliteral">"*.py"</span>, <span class="stringliteral">"*.php"</span>]</div> <div class="line"><a id="l00084" name="l00084"></a><span class="lineno"><a class="line" href="classdoxygen__mcp_1_1server_1_1_doxygen_config.html#a5a3fae7288898347116f0243263e8583"> 84</a></span> recursive: bool = <span class="keyword">True</span></div> <div class="line"><a id="l00085" name="l00085"></a><span class="lineno"><a class="line" href="classdoxygen__mcp_1_1server_1_1_doxygen_config.html#a173bcfefcfd37eceb942aab59bda1f7a"> 85</a></span> exclude_patterns: List[str] = []</div> <div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span> </div> <div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span> <span class="comment"># Language optimization</span></div> <div class="line"><a id="l00088" name="l00088"></a><span class="lineno"><a class="line" href="classdoxygen__mcp_1_1server_1_1_doxygen_config.html#acc8b78a47fb90fad917c384138e43247"> 88</a></span> optimize_output_for_c: bool = <span class="keyword">False</span></div> <div class="line"><a id="l00089" name="l00089"></a><span class="lineno"><a class="line" href="classdoxygen__mcp_1_1server_1_1_doxygen_config.html#a9e9713aea987103b4e8eddf9d3171bfa"> 89</a></span> optimize_output_java: bool = <span class="keyword">False</span></div> <div class="line"><a id="l00090" name="l00090"></a><span class="lineno"><a class="line" href="classdoxygen__mcp_1_1server_1_1_doxygen_config.html#a40df715edef085f3b0c1a06710275ac2"> 90</a></span> optimize_for_fortran: bool = <span class="keyword">False</span></div> <div class="line"><a id="l00091" name="l00091"></a><span class="lineno"><a class="line" href="classdoxygen__mcp_1_1server_1_1_doxygen_config.html#ab2bb4479c142874cd736e825d1707353"> 91</a></span> optimize_output_vhdl: bool = <span class="keyword">False</span></div> <div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span> </div> <div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span> <span class="comment"># Output formats</span></div> <div class="line"><a id="l00094" name="l00094"></a><span class="lineno"><a class="line" href="classdoxygen__mcp_1_1server_1_1_doxygen_config.html#a89d579b19bd92137e8cc564038a09a07"> 94</a></span> generate_html: bool = <span class="keyword">True</span></div> <div class="line"><a id="l00095" name="l00095"></a><span class="lineno"><a class="line" href="classdoxygen__mcp_1_1server_1_1_doxygen_config.html#a5a9f3ec535043499eb122cd5fb7735bd"> 95</a></span> generate_latex: bool = <span class="keyword">False</span></div> <div class="line"><a id="l00096" name="l00096"></a><span class="lineno"><a class="line" href="classdoxygen__mcp_1_1server_1_1_doxygen_config.html#a5934e1229e1e9f5195e2d39619103a3f"> 96</a></span> generate_rtf: bool = <span class="keyword">False</span></div> <div class="line"><a id="l00097" name="l00097"></a><span class="lineno"><a class="line" href="classdoxygen__mcp_1_1server_1_1_doxygen_config.html#a61ee30ccdc0c3201ff75c7f85d05eff0"> 97</a></span> generate_man: bool = <span class="keyword">False</span></div> <div class="line"><a id="l00098" name="l00098"></a><span class="lineno"><a class="line" href="classdoxygen__mcp_1_1server_1_1_doxygen_config.html#a3f496e0668054d9d9c3750f84882827a"> 98</a></span> generate_xml: bool = <span class="keyword">False</span></div> <div class="line"><a id="l00099" name="l00099"></a><span class="lineno"><a class="line" href="classdoxygen__mcp_1_1server_1_1_doxygen_config.html#a7978ab115e693bc765cf25c63d4ed0bb"> 99</a></span> generate_docbook: bool = <span class="keyword">False</span></div> <div class="line"><a id="l00100" name="l00100"></a><span class="lineno"> 100</span> </div> <div class="line"><a id="l00101" name="l00101"></a><span class="lineno"> 101</span> <span class="comment"># Documentation extraction</span></div> <div class="line"><a id="l00102" name="l00102"></a><span class="lineno"><a class="line" href="classdoxygen__mcp_1_1server_1_1_doxygen_config.html#a0c4ae57a187fc27ddd2644e3f52d833b"> 102</a></span> extract_all: bool = <span class="keyword">True</span></div> <div class="line"><a id="l00103" name="l00103"></a><span class="lineno"><a class="line" href="classdoxygen__mcp_1_1server_1_1_doxygen_config.html#a59d7af7eada5bb034a7c273f8c4cfc2b"> 103</a></span> extract_private: bool = <span class="keyword">False</span></div> <div class="line"><a id="l00104" name="l00104"></a><span class="lineno"><a class="line" href="classdoxygen__mcp_1_1server_1_1_doxygen_config.html#a51eb44d26dcd58c1cda68a614164acd5"> 104</a></span> extract_static: bool = <span class="keyword">True</span></div> <div class="line"><a id="l00105" name="l00105"></a><span class="lineno"><a class="line" href="classdoxygen__mcp_1_1server_1_1_doxygen_config.html#a193762a6503870e48f4a5aba7344bf49"> 105</a></span> extract_local_classes: bool = <span class="keyword">True</span></div> <div class="line"><a id="l00106" name="l00106"></a><span class="lineno"> 106</span> </div> <div class="line"><a id="l00107" name="l00107"></a><span class="lineno"> 107</span> <span class="comment"># Diagram generation</span></div> <div class="line"><a id="l00108" name="l00108"></a><span class="lineno"><a class="line" href="classdoxygen__mcp_1_1server_1_1_doxygen_config.html#aa21414a85efe7924af0c713fc7465895"> 108</a></span> have_dot: bool = <span class="keyword">True</span></div> <div class="line"><a id="l00109" name="l00109"></a><span class="lineno"><a class="line" href="classdoxygen__mcp_1_1server_1_1_doxygen_config.html#a3027c0ba11d602bb11d14a6114140532"> 109</a></span> class_graph: bool = <span class="keyword">True</span></div> <div class="line"><a id="l00110" name="l00110"></a><span class="lineno"><a class="line" href="classdoxygen__mcp_1_1server_1_1_doxygen_config.html#a36f43d51b62c187bdad5270761dce2b7"> 110</a></span> collaboration_graph: bool = <span class="keyword">True</span></div> <div class="line"><a id="l00111" name="l00111"></a><span class="lineno"><a class="line" href="classdoxygen__mcp_1_1server_1_1_doxygen_config.html#accc9e46388323950355530da1f925918"> 111</a></span> call_graph: bool = <span class="keyword">False</span></div> <div class="line"><a id="l00112" name="l00112"></a><span class="lineno"><a class="line" href="classdoxygen__mcp_1_1server_1_1_doxygen_config.html#a61e37e13cab5999d6b4491b0245e16d2"> 112</a></span> caller_graph: bool = <span class="keyword">False</span></div> <div class="line"><a id="l00113" name="l00113"></a><span class="lineno"><a class="line" href="classdoxygen__mcp_1_1server_1_1_doxygen_config.html#acedbd7948eeb3167df11c289ce6a778a"> 113</a></span> include_graph: bool = <span class="keyword">True</span></div> <div class="line"><a id="l00114" name="l00114"></a><span class="lineno"><a class="line" href="classdoxygen__mcp_1_1server_1_1_doxygen_config.html#ae3611dc10b8b859fb02d699dcc04d838"> 114</a></span> included_by_graph: bool = <span class="keyword">True</span></div> <div class="line"><a id="l00115" name="l00115"></a><span class="lineno"> 115</span> </div> <div class="line"><a id="l00116" name="l00116"></a><span class="lineno"> 116</span> <span class="comment"># Advanced features</span></div> <div class="line"><a id="l00117" name="l00117"></a><span class="lineno"><a class="line" href="classdoxygen__mcp_1_1server_1_1_doxygen_config.html#a9abf9772599c00bbfc46400e402fecfd"> 117</a></span> source_browser: bool = <span class="keyword">True</span></div> <div class="line"><a id="l00118" name="l00118"></a><span class="lineno"><a class="line" href="classdoxygen__mcp_1_1server_1_1_doxygen_config.html#a0522caf549aab6cbfb353abf3166cdb5"> 118</a></span> inline_sources: bool = <span class="keyword">False</span></div> <div class="line"><a id="l00119" name="l00119"></a><span class="lineno"><a class="line" href="classdoxygen__mcp_1_1server_1_1_doxygen_config.html#ac04bf9add10b2a72c7b166fc180dd51e"> 119</a></span> strip_code_comments: bool = <span class="keyword">True</span></div> <div class="line"><a id="l00120" name="l00120"></a><span class="lineno"><a class="line" href="classdoxygen__mcp_1_1server_1_1_doxygen_config.html#ad999a4642655bcc240eddbd4280db965"> 120</a></span> referenced_by_relation: bool = <span class="keyword">True</span></div> <div class="line"><a id="l00121" name="l00121"></a><span class="lineno"><a class="line" href="classdoxygen__mcp_1_1server_1_1_doxygen_config.html#af93207742d0f5c81dd5483b3a1e39d8f"> 121</a></span> references_relation: bool = <span class="keyword">True</span></div> <div class="line"><a id="l00122" name="l00122"></a><span class="lineno"> 122</span> </div> <div class="foldopen" id="foldopen00123" data-start="" data-end=""> <div class="line"><a id="l00123" name="l00123"></a><span class="lineno"><a class="line" href="classdoxygen__mcp_1_1server_1_1_doxygen_config.html#a5ae77c0455aee3e6a2adbc3d4d6cbe66"> 123</a></span> <span class="keyword">def </span><a class="code hl_function" href="classdoxygen__mcp_1_1server_1_1_doxygen_config.html#a5ae77c0455aee3e6a2adbc3d4d6cbe66">to_doxyfile</a>(self) -> str:</div> <div class="line"><a id="l00124" name="l00124"></a><span class="lineno"> 124</span> <span class="stringliteral">"""</span></div> <div class="line"><a id="l00125" name="l00125"></a><span class="lineno"> 125</span><span class="stringliteral"> @brief Convert configuration to Doxyfile format</span></div> <div class="line"><a id="l00126" name="l00126"></a><span class="lineno"> 126</span><span class="stringliteral"> @return String containing complete Doxyfile configuration</span></div> <div class="line"><a id="l00127" name="l00127"></a><span class="lineno"> 127</span><span class="stringliteral"> </span></div> <div class="line"><a id="l00128" name="l00128"></a><span class="lineno"> 128</span><span class="stringliteral"> @details Generates a complete Doxyfile configuration string that can be</span></div> <div class="line"><a id="l00129" name="l00129"></a><span class="lineno"> 129</span><span class="stringliteral"> written to disk and used with the doxygen command-line tool. The output</span></div> <div class="line"><a id="l00130" name="l00130"></a><span class="lineno"> 130</span><span class="stringliteral"> includes all configured options with appropriate YES/NO values and</span></div> <div class="line"><a id="l00131" name="l00131"></a><span class="lineno"> 131</span><span class="stringliteral"> proper escaping for file paths and patterns.</span></div> <div class="line"><a id="l00132" name="l00132"></a><span class="lineno"> 132</span><span class="stringliteral"> </span></div> <div class="line"><a id="l00133" name="l00133"></a><span class="lineno"> 133</span><span class="stringliteral"> @note The generated Doxyfile is compatible with Doxygen 1.9.0+</span></div> <div class="line"><a id="l00134" name="l00134"></a><span class="lineno"> 134</span><span class="stringliteral"> """</span></div> <div class="line"><a id="l00135" name="l00135"></a><span class="lineno"> 135</span> lines = [</div> <div class="line"><a id="l00136" name="l00136"></a><span class="lineno"> 136</span> f<span class="stringliteral">"# Doxyfile generated by Doxygen MCP Server"</span>,</div> <div class="line"><a id="l00137" name="l00137"></a><span class="lineno"> 137</span> f<span class="stringliteral">""</span>,</div> <div class="line"><a id="l00138" name="l00138"></a><span class="lineno"> 138</span> f<span class="stringliteral">"# Project related configuration options"</span>,</div> <div class="line"><a id="l00139" name="l00139"></a><span class="lineno"> 139</span> f<span class="stringliteral">"PROJECT_NAME = \"{self.project_name}\""</span>,</div> <div class="line"><a id="l00140" name="l00140"></a><span class="lineno"> 140</span> f<span class="stringliteral">"PROJECT_NUMBER = \"{self.project_number}\""</span>,</div> <div class="line"><a id="l00141" name="l00141"></a><span class="lineno"> 141</span> f<span class="stringliteral">"PROJECT_BRIEF = \"{self.project_brief}\""</span>,</div> <div class="line"><a id="l00142" name="l00142"></a><span class="lineno"> 142</span> f<span class="stringliteral">"PROJECT_LOGO = \"{self.project_logo}\""</span>,</div> <div class="line"><a id="l00143" name="l00143"></a><span class="lineno"> 143</span> f<span class="stringliteral">"OUTPUT_DIRECTORY = \"{self.output_directory}\""</span>,</div> <div class="line"><a id="l00144" name="l00144"></a><span class="lineno"> 144</span> f<span class="stringliteral">""</span>,</div> <div class="line"><a id="l00145" name="l00145"></a><span class="lineno"> 145</span> f<span class="stringliteral">"# Build related configuration options"</span>,</div> <div class="line"><a id="l00146" name="l00146"></a><span class="lineno"> 146</span> f<span class="stringliteral">"EXTRACT_ALL = {'YES' if self.extract_all else 'NO'}"</span>,</div> <div class="line"><a id="l00147" name="l00147"></a><span class="lineno"> 147</span> f<span class="stringliteral">"EXTRACT_PRIVATE = {'YES' if self.extract_private else 'NO'}"</span>,</div> <div class="line"><a id="l00148" name="l00148"></a><span class="lineno"> 148</span> f<span class="stringliteral">"EXTRACT_STATIC = {'YES' if self.extract_static else 'NO'}"</span>,</div> <div class="line"><a id="l00149" name="l00149"></a><span class="lineno"> 149</span> f<span class="stringliteral">"EXTRACT_LOCAL_CLASSES = {'YES' if self.extract_local_classes else 'NO'}"</span>,</div> <div class="line"><a id="l00150" name="l00150"></a><span class="lineno"> 150</span> f<span class="stringliteral">""</span>,</div> <div class="line"><a id="l00151" name="l00151"></a><span class="lineno"> 151</span> f<span class="stringliteral">"# Input related configuration options"</span>,</div> <div class="line"><a id="l00152" name="l00152"></a><span class="lineno"> 152</span> f<span class="stringliteral">"INPUT = {' '.join(self.input_paths)}"</span>,</div> <div class="line"><a id="l00153" name="l00153"></a><span class="lineno"> 153</span> f<span class="stringliteral">"FILE_PATTERNS = {' '.join(self.file_patterns)}"</span>,</div> <div class="line"><a id="l00154" name="l00154"></a><span class="lineno"> 154</span> f<span class="stringliteral">"RECURSIVE = {'YES' if self.recursive else 'NO'}"</span>,</div> <div class="line"><a id="l00155" name="l00155"></a><span class="lineno"> 155</span> ]</div> <div class="line"><a id="l00156" name="l00156"></a><span class="lineno"> 156</span> </div> <div class="line"><a id="l00157" name="l00157"></a><span class="lineno"> 157</span> <span class="keywordflow">if</span> self.<a class="code hl_variable" href="classdoxygen__mcp_1_1server_1_1_doxygen_config.html#a173bcfefcfd37eceb942aab59bda1f7a">exclude_patterns</a>:</div> <div class="line"><a id="l00158" name="l00158"></a><span class="lineno"> 158</span> lines.append(f<span class="stringliteral">"EXCLUDE_PATTERNS = {' '.join(self.exclude_patterns)}"</span>)</div> <div class="line"><a id="l00159" name="l00159"></a><span class="lineno"> 159</span> </div> <div class="line"><a id="l00160" name="l00160"></a><span class="lineno"> 160</span> lines.extend([</div> <div class="line"><a id="l00161" name="l00161"></a><span class="lineno"> 161</span> f<span class="stringliteral">""</span>,</div> <div class="line"><a id="l00162" name="l00162"></a><span class="lineno"> 162</span> f<span class="stringliteral">"# Language optimization"</span>,</div> <div class="line"><a id="l00163" name="l00163"></a><span class="lineno"> 163</span> f<span class="stringliteral">"OPTIMIZE_OUTPUT_FOR_C = {'YES' if self.optimize_output_for_c else 'NO'}"</span>,</div> <div class="line"><a id="l00164" name="l00164"></a><span class="lineno"> 164</span> f<span class="stringliteral">"OPTIMIZE_OUTPUT_JAVA = {'YES' if self.optimize_output_java else 'NO'}"</span>,</div> <div class="line"><a id="l00165" name="l00165"></a><span class="lineno"> 165</span> f<span class="stringliteral">"OPTIMIZE_FOR_FORTRAN = {'YES' if self.optimize_for_fortran else 'NO'}"</span>,</div> <div class="line"><a id="l00166" name="l00166"></a><span class="lineno"> 166</span> f<span class="stringliteral">"OPTIMIZE_OUTPUT_VHDL = {'YES' if self.optimize_output_vhdl else 'NO'}"</span>,</div> <div class="line"><a id="l00167" name="l00167"></a><span class="lineno"> 167</span> f<span class="stringliteral">""</span>,</div> <div class="line"><a id="l00168" name="l00168"></a><span class="lineno"> 168</span> f<span class="stringliteral">"# Output format configuration"</span>,</div> <div class="line"><a id="l00169" name="l00169"></a><span class="lineno"> 169</span> f<span class="stringliteral">"GENERATE_HTML = {'YES' if self.generate_html else 'NO'}"</span>,</div> <div class="line"><a id="l00170" name="l00170"></a><span class="lineno"> 170</span> f<span class="stringliteral">"GENERATE_LATEX = {'YES' if self.generate_latex else 'NO'}"</span>,</div> <div class="line"><a id="l00171" name="l00171"></a><span class="lineno"> 171</span> f<span class="stringliteral">"GENERATE_RTF = {'YES' if self.generate_rtf else 'NO'}"</span>,</div> <div class="line"><a id="l00172" name="l00172"></a><span class="lineno"> 172</span> f<span class="stringliteral">"GENERATE_MAN = {'YES' if self.generate_man else 'NO'}"</span>,</div> <div class="line"><a id="l00173" name="l00173"></a><span class="lineno"> 173</span> f<span class="stringliteral">"GENERATE_XML = {'YES' if self.generate_xml else 'NO'}"</span>,</div> <div class="line"><a id="l00174" name="l00174"></a><span class="lineno"> 174</span> f<span class="stringliteral">"GENERATE_DOCBOOK = {'YES' if self.generate_docbook else 'NO'}"</span>,</div> <div class="line"><a id="l00175" name="l00175"></a><span class="lineno"> 175</span> f<span class="stringliteral">""</span>,</div> <div class="line"><a id="l00176" name="l00176"></a><span class="lineno"> 176</span> f<span class="stringliteral">"# Diagram generation"</span>,</div> <div class="line"><a id="l00177" name="l00177"></a><span class="lineno"> 177</span> f<span class="stringliteral">"HAVE_DOT = {'YES' if self.have_dot else 'NO'}"</span>,</div> <div class="line"><a id="l00178" name="l00178"></a><span class="lineno"> 178</span> f<span class="stringliteral">"CLASS_GRAPH = {'YES' if self.class_graph else 'NO'}"</span>,</div> <div class="line"><a id="l00179" name="l00179"></a><span class="lineno"> 179</span> f<span class="stringliteral">"COLLABORATION_GRAPH = {'YES' if self.collaboration_graph else 'NO'}"</span>,</div> <div class="line"><a id="l00180" name="l00180"></a><span class="lineno"> 180</span> f<span class="stringliteral">"CALL_GRAPH = {'YES' if self.call_graph else 'NO'}"</span>,</div> <div class="line"><a id="l00181" name="l00181"></a><span class="lineno"> 181</span> f<span class="stringliteral">"CALLER_GRAPH = {'YES' if self.caller_graph else 'NO'}"</span>,</div> <div class="line"><a id="l00182" name="l00182"></a><span class="lineno"> 182</span> f<span class="stringliteral">"INCLUDE_GRAPH = {'YES' if self.include_graph else 'NO'}"</span>,</div> <div class="line"><a id="l00183" name="l00183"></a><span class="lineno"> 183</span> f<span class="stringliteral">"INCLUDED_BY_GRAPH = {'YES' if self.included_by_graph else 'NO'}"</span>,</div> <div class="line"><a id="l00184" name="l00184"></a><span class="lineno"> 184</span> f<span class="stringliteral">""</span>,</div> <div class="line"><a id="l00185" name="l00185"></a><span class="lineno"> 185</span> f<span class="stringliteral">"# Source browsing"</span>,</div> <div class="line"><a id="l00186" name="l00186"></a><span class="lineno"> 186</span> f<span class="stringliteral">"SOURCE_BROWSER = {'YES' if self.source_browser else 'NO'}"</span>,</div> <div class="line"><a id="l00187" name="l00187"></a><span class="lineno"> 187</span> f<span class="stringliteral">"INLINE_SOURCES = {'YES' if self.inline_sources else 'NO'}"</span>,</div> <div class="line"><a id="l00188" name="l00188"></a><span class="lineno"> 188</span> f<span class="stringliteral">"STRIP_CODE_COMMENTS = {'YES' if self.strip_code_comments else 'NO'}"</span>,</div> <div class="line"><a id="l00189" name="l00189"></a><span class="lineno"> 189</span> f<span class="stringliteral">"REFERENCED_BY_RELATION = {'YES' if self.referenced_by_relation else 'NO'}"</span>,</div> <div class="line"><a id="l00190" name="l00190"></a><span class="lineno"> 190</span> f<span class="stringliteral">"REFERENCES_RELATION = {'YES' if self.references_relation else 'NO'}"</span>,</div> <div class="line"><a id="l00191" name="l00191"></a><span class="lineno"> 191</span> ])</div> <div class="line"><a id="l00192" name="l00192"></a><span class="lineno"> 192</span> </div> <div class="line"><a id="l00193" name="l00193"></a><span class="lineno"> 193</span> <span class="keywordflow">return</span> <span class="stringliteral">"\n"</span>.join(lines)</div> <div class="line"><a id="l00194" name="l00194"></a><span class="lineno"> 194</span> </div> <div class="line"><a id="l00195" name="l00195"></a><span class="lineno"> 195</span> </div> <div class="line"><a id="l00196" name="l00196"></a><span class="lineno"> 196</span><span class="preprocessor">@mcp.tool()</span></div> </div> </div> <div class="foldopen" id="foldopen00197" data-start="" data-end=""> <div class="line"><a id="l00197" name="l00197"></a><span class="lineno"><a class="line" href="namespacedoxygen__mcp_1_1server.html#a219b291d78942e6529d5d14a29afb3cd"> 197</a></span><span class="keyword">async def </span><a class="code hl_function" href="namespacedoxygen__mcp_1_1server.html#a219b291d78942e6529d5d14a29afb3cd">create_doxygen_project</a>(</div> <div class="line"><a id="l00198" name="l00198"></a><span class="lineno"> 198</span> project_name: str,</div> <div class="line"><a id="l00199" name="l00199"></a><span class="lineno"> 199</span> project_path: str,</div> <div class="line"><a id="l00200" name="l00200"></a><span class="lineno"> 200</span> language: str = <span class="stringliteral">"mixed"</span>,</div> <div class="line"><a id="l00201" name="l00201"></a><span class="lineno"> 201</span> include_subdirs: bool = <span class="keyword">True</span>,</div> <div class="line"><a id="l00202" name="l00202"></a><span class="lineno"> 202</span> extract_private: bool = <span class="keyword">False</span>,</div> <div class="line"><a id="l00203" name="l00203"></a><span class="lineno"> 203</span>) -> str:</div> <div class="line"><a id="l00204" name="l00204"></a><span class="lineno"> 204</span> <span class="stringliteral">"""Initialize a new Doxygen documentation project with configuration"""</span></div> <div class="line"><a id="l00205" name="l00205"></a><span class="lineno"> 205</span> <span class="keywordflow">try</span>:</div> <div class="line"><a id="l00206" name="l00206"></a><span class="lineno"> 206</span> <span class="comment"># Sanitize the project path</span></div> <div class="line"><a id="l00207" name="l00207"></a><span class="lineno"> 207</span> safe_project_path = Path(os.path.abspath(os.path.realpath(project_path)))</div> <div class="line"><a id="l00208" name="l00208"></a><span class="lineno"> 208</span> <span class="keywordflow">if</span> <span class="stringliteral">"PYTEST_CURRENT_TEST"</span> <span class="keywordflow">not</span> <span class="keywordflow">in</span> os.environ:</div> <div class="line"><a id="l00209" name="l00209"></a><span class="lineno"> 209</span> <span class="keywordflow">if</span> <span class="keywordflow">not</span> safe_project_path.is_dir():</div> <div class="line"><a id="l00210" name="l00210"></a><span class="lineno"> 210</span> <span class="keywordflow">return</span> f<span class="stringliteral">"❌ Invalid project path: {project_path}"</span></div> <div class="line"><a id="l00211" name="l00211"></a><span class="lineno"> 211</span> <span class="keywordflow">if</span> <span class="keywordflow">not</span> str(safe_project_path).startswith(os.getcwd()):</div> <div class="line"><a id="l00212" name="l00212"></a><span class="lineno"> 212</span> <span class="keywordflow">return</span> f<span class="stringliteral">"❌ Project path is not within the current working directory: {project_path}"</span></div> <div class="line"><a id="l00213" name="l00213"></a><span class="lineno"> 213</span> </div> <div class="line"><a id="l00214" name="l00214"></a><span class="lineno"> 214</span> <span class="comment"># Create project directory if it doesn't exist</span></div> <div class="line"><a id="l00215" name="l00215"></a><span class="lineno"> 215</span> safe_project_path.mkdir(parents=<span class="keyword">True</span>, exist_ok=<span class="keyword">True</span>)</div> <div class="line"><a id="l00216" name="l00216"></a><span class="lineno"> 216</span> </div> <div class="line"><a id="l00217" name="l00217"></a><span class="lineno"> 217</span> <span class="comment"># Create configuration based on language</span></div> <div class="line"><a id="l00218" name="l00218"></a><span class="lineno"> 218</span> config = <a class="code hl_class" href="classdoxygen__mcp_1_1server_1_1_doxygen_config.html">DoxygenConfig</a>(</div> <div class="line"><a id="l00219" name="l00219"></a><span class="lineno"> 219</span> project_name=project_name,</div> <div class="line"><a id="l00220" name="l00220"></a><span class="lineno"> 220</span> output_directory=str(Path(project_path) / <span class="stringliteral">"docs"</span>),</div> <div class="line"><a id="l00221" name="l00221"></a><span class="lineno"> 221</span> input_paths=[str(project_path)],</div> <div class="line"><a id="l00222" name="l00222"></a><span class="lineno"> 222</span> recursive=include_subdirs,</div> <div class="line"><a id="l00223" name="l00223"></a><span class="lineno"> 223</span> extract_private=extract_private</div> <div class="line"><a id="l00224" name="l00224"></a><span class="lineno"> 224</span> )</div> <div class="line"><a id="l00225" name="l00225"></a><span class="lineno"> 225</span> </div> <div class="line"><a id="l00226" name="l00226"></a><span class="lineno"> 226</span> <span class="comment"># Language-specific optimizations</span></div> <div class="line"><a id="l00227" name="l00227"></a><span class="lineno"> 227</span> <span class="keywordflow">if</span> language == <span class="stringliteral">"c"</span>:</div> <div class="line"><a id="l00228" name="l00228"></a><span class="lineno"> 228</span> config.optimize_output_for_c = <span class="keyword">True</span></div> <div class="line"><a id="l00229" name="l00229"></a><span class="lineno"> 229</span> config.file_patterns = [<span class="stringliteral">"*.c"</span>, <span class="stringliteral">"*.h"</span>]</div> <div class="line"><a id="l00230" name="l00230"></a><span class="lineno"> 230</span> <span class="keywordflow">elif</span> language == <span class="stringliteral">"cpp"</span>:</div> <div class="line"><a id="l00231" name="l00231"></a><span class="lineno"> 231</span> config.file_patterns = [<span class="stringliteral">"*.cpp"</span>, <span class="stringliteral">"*.hpp"</span>, <span class="stringliteral">"*.cc"</span>, <span class="stringliteral">"*.hh"</span>, <span class="stringliteral">"*.cxx"</span>, <span class="stringliteral">"*.hxx"</span>]</div> <div class="line"><a id="l00232" name="l00232"></a><span class="lineno"> 232</span> <span class="keywordflow">elif</span> language == <span class="stringliteral">"python"</span>:</div> <div class="line"><a id="l00233" name="l00233"></a><span class="lineno"> 233</span> config.optimize_output_java = <span class="keyword">True</span> <span class="comment"># Python uses Java-style optimization</span></div> <div class="line"><a id="l00234" name="l00234"></a><span class="lineno"> 234</span> config.file_patterns = [<span class="stringliteral">"*.py"</span>]</div> <div class="line"><a id="l00235" name="l00235"></a><span class="lineno"> 235</span> <span class="keywordflow">elif</span> language == <span class="stringliteral">"php"</span>:</div> <div class="line"><a id="l00236" name="l00236"></a><span class="lineno"> 236</span> config.file_patterns = [<span class="stringliteral">"*.php"</span>, <span class="stringliteral">"*.php3"</span>, <span class="stringliteral">"*.inc"</span>]</div> <div class="line"><a id="l00237" name="l00237"></a><span class="lineno"> 237</span> <span class="keywordflow">elif</span> language == <span class="stringliteral">"java"</span>:</div> <div class="line"><a id="l00238" name="l00238"></a><span class="lineno"> 238</span> config.optimize_output_java = <span class="keyword">True</span></div> <div class="line"><a id="l00239" name="l00239"></a><span class="lineno"> 239</span> config.file_patterns = [<span class="stringliteral">"*.java"</span>]</div> <div class="line"><a id="l00240" name="l00240"></a><span class="lineno"> 240</span> <span class="keywordflow">elif</span> language == <span class="stringliteral">"csharp"</span>:</div> <div class="line"><a id="l00241" name="l00241"></a><span class="lineno"> 241</span> config.file_patterns = [<span class="stringliteral">"*.cs"</span>]</div> <div class="line"><a id="l00242" name="l00242"></a><span class="lineno"> 242</span> <span class="keywordflow">elif</span> language == <span class="stringliteral">"javascript"</span>:</div> <div class="line"><a id="l00243" name="l00243"></a><span class="lineno"> 243</span> config.file_patterns = [<span class="stringliteral">"*.js"</span>, <span class="stringliteral">"*.jsx"</span>, <span class="stringliteral">"*.ts"</span>, <span class="stringliteral">"*.tsx"</span>]</div> <div class="line"><a id="l00244" name="l00244"></a><span class="lineno"> 244</span> </div> <div class="line"><a id="l00245" name="l00245"></a><span class="lineno"> 245</span> <span class="comment"># Save configuration</span></div> <div class="line"><a id="l00246" name="l00246"></a><span class="lineno"> 246</span> doxyfile_path = Path(project_path) / <span class="stringliteral">"Doxyfile"</span></div> <div class="line"><a id="l00247" name="l00247"></a><span class="lineno"> 247</span> <span class="keyword">with</span> open(doxyfile_path, <span class="stringliteral">'w'</span>, encoding=<span class="stringliteral">'utf-8'</span>) <span class="keyword">as</span> f:</div> <div class="line"><a id="l00248" name="l00248"></a><span class="lineno"> 248</span> f.write(config.to_doxyfile())</div> <div class="line"><a id="l00249" name="l00249"></a><span class="lineno"> 249</span> </div> <div class="line"><a id="l00250" name="l00250"></a><span class="lineno"> 250</span> result = f<span class="stringliteral">"""✅ Doxygen project '{project_name}' created successfully!</span></div> <div class="line"><a id="l00251" name="l00251"></a><span class="lineno"> 251</span><span class="stringliteral"></span> </div> <div class="line"><a id="l00252" name="l00252"></a><span class="lineno"> 252</span><span class="stringliteral">📁 Project Path: {project_path}</span></div> <div class="line"><a id="l00253" name="l00253"></a><span class="lineno"> 253</span><span class="stringliteral">🔧 Language: {language}</span></div> <div class="line"><a id="l00254" name="l00254"></a><span class="lineno"> 254</span><span class="stringliteral">📄 Configuration: {doxyfile_path}</span></div> <div class="line"><a id="l00255" name="l00255"></a><span class="lineno"> 255</span><span class="stringliteral"></span> </div> <div class="line"><a id="l00256" name="l00256"></a><span class="lineno"> 256</span><span class="stringliteral">Configuration Summary:</span></div> <div class="line"><a id="l00257" name="l00257"></a><span class="lineno"> 257</span><span class="stringliteral">- Output Directory: {config.output_directory}</span></div> <div class="line"><a id="l00258" name="l00258"></a><span class="lineno"> 258</span><span class="stringliteral">- Recursive Scanning: {'Yes' if include_subdirs else 'No'}</span></div> <div class="line"><a id="l00259" name="l00259"></a><span class="lineno"> 259</span><span class="stringliteral">- Extract Private Members: {'Yes' if extract_private else 'No'}</span></div> <div class="line"><a id="l00260" name="l00260"></a><span class="lineno"> 260</span><span class="stringliteral">- File Patterns: {', '.join(config.file_patterns)}</span></div> <div class="line"><a id="l00261" name="l00261"></a><span class="lineno"> 261</span><span class="stringliteral"></span> </div> <div class="line"><a id="l00262" name="l00262"></a><span class="lineno"> 262</span><span class="stringliteral">Next Steps:</span></div> <div class="line"><a id="l00263" name="l00263"></a><span class="lineno"> 263</span><span class="stringliteral">1. Review and customize the Doxyfile if needed</span></div> <div class="line"><a id="l00264" name="l00264"></a><span class="lineno"> 264</span><span class="stringliteral">2. Add documentation comments to your source code</span></div> <div class="line"><a id="l00265" name="l00265"></a><span class="lineno"> 265</span><span class="stringliteral">3. Run 'generate_documentation' to create docs</span></div> <div class="line"><a id="l00266" name="l00266"></a><span class="lineno"> 266</span><span class="stringliteral"></span> </div> <div class="line"><a id="l00267" name="l00267"></a><span class="lineno"> 267</span><span class="stringliteral">The project is ready for documentation generation!"""</span></div> <div class="line"><a id="l00268" name="l00268"></a><span class="lineno"> 268</span> </div> <div class="line"><a id="l00269" name="l00269"></a><span class="lineno"> 269</span> <span class="keywordflow">return</span> result</div> <div class="line"><a id="l00270" name="l00270"></a><span class="lineno"> 270</span> </div> <div class="line"><a id="l00271" name="l00271"></a><span class="lineno"> 271</span> <span class="keywordflow">except</span> Exception <span class="keyword">as</span> e:</div> <div class="line"><a id="l00272" name="l00272"></a><span class="lineno"> 272</span> <span class="keywordflow">return</span> f<span class="stringliteral">"❌ Failed to create project: {str(e)}"</span></div> <div class="line"><a id="l00273" name="l00273"></a><span class="lineno"> 273</span> </div> <div class="line"><a id="l00274" name="l00274"></a><span class="lineno"> 274</span><span class="preprocessor">@mcp.tool()</span></div> </div> <div class="foldopen" id="foldopen00275" data-start="" data-end=""> <div class="line"><a id="l00275" name="l00275"></a><span class="lineno"><a class="line" href="namespacedoxygen__mcp_1_1server.html#af54109e1fe48151097551d8b6514733a"> 275</a></span><span class="keyword">async def </span><a class="code hl_function" href="namespacedoxygen__mcp_1_1server.html#af54109e1fe48151097551d8b6514733a">generate_documentation</a>(</div> <div class="line"><a id="l00276" name="l00276"></a><span class="lineno"> 276</span> project_path: str,</div> <div class="line"><a id="l00277" name="l00277"></a><span class="lineno"> 277</span> output_format: str = <span class="stringliteral">"html"</span>,</div> <div class="line"><a id="l00278" name="l00278"></a><span class="lineno"> 278</span> clean_output: bool = <span class="keyword">True</span>,</div> <div class="line"><a id="l00279" name="l00279"></a><span class="lineno"> 279</span> verbose: bool = <span class="keyword">False</span>,</div> <div class="line"><a id="l00280" name="l00280"></a><span class="lineno"> 280</span>) -> str:</div> <div class="line"><a id="l00281" name="l00281"></a><span class="lineno"> 281</span> <span class="stringliteral">"""Generate documentation from source code using Doxygen"""</span></div> <div class="line"><a id="l00282" name="l00282"></a><span class="lineno"> 282</span> <span class="comment"># Sanitize the project path</span></div> <div class="line"><a id="l00283" name="l00283"></a><span class="lineno"> 283</span> safe_project_path = Path(os.path.abspath(os.path.realpath(project_path)))</div> <div class="line"><a id="l00284" name="l00284"></a><span class="lineno"> 284</span> <span class="keywordflow">if</span> <span class="stringliteral">"PYTEST_CURRENT_TEST"</span> <span class="keywordflow">not</span> <span class="keywordflow">in</span> os.environ:</div> <div class="line"><a id="l00285" name="l00285"></a><span class="lineno"> 285</span> <span class="keywordflow">if</span> <span class="keywordflow">not</span> safe_project_path.is_dir():</div> <div class="line"><a id="l00286" name="l00286"></a><span class="lineno"> 286</span> <span class="keywordflow">return</span> f<span class="stringliteral">"❌ Invalid project path: {project_path}"</span></div> <div class="line"><a id="l00287" name="l00287"></a><span class="lineno"> 287</span> <span class="keywordflow">if</span> <span class="keywordflow">not</span> str(safe_project_path).startswith(os.getcwd()):</div> <div class="line"><a id="l00288" name="l00288"></a><span class="lineno"> 288</span> <span class="keywordflow">return</span> f<span class="stringliteral">"❌ Project path is not within the current working directory: {project_path}"</span></div> <div class="line"><a id="l00289" name="l00289"></a><span class="lineno"> 289</span> </div> <div class="line"><a id="l00290" name="l00290"></a><span class="lineno"> 290</span> doxyfile_path = safe_project_path / <span class="stringliteral">"Doxyfile"</span></div> <div class="line"><a id="l00291" name="l00291"></a><span class="lineno"> 291</span> <span class="keywordflow">if</span> <span class="keywordflow">not</span> doxyfile_path.exists():</div> <div class="line"><a id="l00292" name="l00292"></a><span class="lineno"> 292</span> <span class="keywordflow">return</span> <span class="stringliteral">"❌ No Doxyfile found. Create a project first using 'create_doxygen_project'."</span></div> <div class="line"><a id="l00293" name="l00293"></a><span class="lineno"> 293</span> </div> <div class="line"><a id="l00294" name="l00294"></a><span class="lineno"> 294</span> <span class="keywordflow">try</span>:</div> <div class="line"><a id="l00295" name="l00295"></a><span class="lineno"> 295</span> <span class="comment"># Check if doxygen is available</span></div> <div class="line"><a id="l00296" name="l00296"></a><span class="lineno"> 296</span> result = subprocess.run([<span class="stringliteral">"doxygen"</span>, <span class="stringliteral">"--version"</span>], capture_output=<span class="keyword">True</span>, text=<span class="keyword">True</span>)</div> <div class="line"><a id="l00297" name="l00297"></a><span class="lineno"> 297</span> <span class="keywordflow">if</span> result.returncode != 0:</div> <div class="line"><a id="l00298" name="l00298"></a><span class="lineno"> 298</span> <span class="keywordflow">return</span> <span class="stringliteral">"❌ Doxygen not found. Please install Doxygen first."</span></div> <div class="line"><a id="l00299" name="l00299"></a><span class="lineno"> 299</span> </div> <div class="line"><a id="l00300" name="l00300"></a><span class="lineno"> 300</span> doxygen_version = result.stdout.strip()</div> <div class="line"><a id="l00301" name="l00301"></a><span class="lineno"> 301</span> </div> <div class="line"><a id="l00302" name="l00302"></a><span class="lineno"> 302</span> <span class="comment"># Run Doxygen</span></div> <div class="line"><a id="l00303" name="l00303"></a><span class="lineno"> 303</span> cmd = [<span class="stringliteral">"doxygen"</span>, str(doxyfile_path)]</div> <div class="line"><a id="l00304" name="l00304"></a><span class="lineno"> 304</span> result = subprocess.run(</div> <div class="line"><a id="l00305" name="l00305"></a><span class="lineno"> 305</span> cmd,</div> <div class="line"><a id="l00306" name="l00306"></a><span class="lineno"> 306</span> cwd=project_path,</div> <div class="line"><a id="l00307" name="l00307"></a><span class="lineno"> 307</span> capture_output=<span class="keyword">True</span>,</div> <div class="line"><a id="l00308" name="l00308"></a><span class="lineno"> 308</span> text=<span class="keyword">True</span></div> <div class="line"><a id="l00309" name="l00309"></a><span class="lineno"> 309</span> )</div> <div class="line"><a id="l00310" name="l00310"></a><span class="lineno"> 310</span> </div> <div class="line"><a id="l00311" name="l00311"></a><span class="lineno"> 311</span> <span class="keywordflow">if</span> result.returncode == 0:</div> <div class="line"><a id="l00312" name="l00312"></a><span class="lineno"> 312</span> <span class="comment"># Parse output for statistics</span></div> <div class="line"><a id="l00313" name="l00313"></a><span class="lineno"> 313</span> output_lines = result.stderr.split(<span class="stringliteral">'\n'</span>)</div> <div class="line"><a id="l00314" name="l00314"></a><span class="lineno"> 314</span> warnings = [line <span class="keywordflow">for</span> line <span class="keywordflow">in</span> output_lines <span class="keywordflow">if</span> <span class="stringliteral">'warning'</span> <span class="keywordflow">in</span> line.lower()]</div> <div class="line"><a id="l00315" name="l00315"></a><span class="lineno"> 315</span> </div> <div class="line"><a id="l00316" name="l00316"></a><span class="lineno"> 316</span> result_text = f<span class="stringliteral">"""✅ Documentation generated successfully!</span></div> <div class="line"><a id="l00317" name="l00317"></a><span class="lineno"> 317</span><span class="stringliteral"></span> </div> <div class="line"><a id="l00318" name="l00318"></a><span class="lineno"> 318</span><span class="stringliteral">🔧 Doxygen Version: {doxygen_version}</span></div> <div class="line"><a id="l00319" name="l00319"></a><span class="lineno"> 319</span><span class="stringliteral">📁 Project: {project_path}</span></div> <div class="line"><a id="l00320" name="l00320"></a><span class="lineno"> 320</span><span class="stringliteral">📊 Warnings: {len(warnings)}</span></div> <div class="line"><a id="l00321" name="l00321"></a><span class="lineno"> 321</span><span class="stringliteral"></span> </div> <div class="line"><a id="l00322" name="l00322"></a><span class="lineno"> 322</span><span class="stringliteral">Generated Files:</span></div> <div class="line"><a id="l00323" name="l00323"></a><span class="lineno"> 323</span><span class="stringliteral">📄 HTML: {Path(project_path) / 'docs' / 'html' / 'index.html'}</span></div> <div class="line"><a id="l00324" name="l00324"></a><span class="lineno"> 324</span><span class="stringliteral"></span> </div> <div class="line"><a id="l00325" name="l00325"></a><span class="lineno"> 325</span><span class="stringliteral">"""</span></div> <div class="line"><a id="l00326" name="l00326"></a><span class="lineno"> 326</span> </div> <div class="line"><a id="l00327" name="l00327"></a><span class="lineno"> 327</span> <span class="keywordflow">if</span> warnings <span class="keywordflow">and</span> verbose:</div> <div class="line"><a id="l00328" name="l00328"></a><span class="lineno"> 328</span> result_text += f<span class="stringliteral">"\n⚠️ Warnings:\n"</span> + <span class="stringliteral">"\n"</span>.join(warnings[:10])</div> <div class="line"><a id="l00329" name="l00329"></a><span class="lineno"> 329</span> <span class="keywordflow">if</span> len(warnings) > 10:</div> <div class="line"><a id="l00330" name="l00330"></a><span class="lineno"> 330</span> result_text += f<span class="stringliteral">"\n... and {len(warnings) - 10} more warnings"</span></div> <div class="line"><a id="l00331" name="l00331"></a><span class="lineno"> 331</span> </div> <div class="line"><a id="l00332" name="l00332"></a><span class="lineno"> 332</span> <span class="keywordflow">if</span> <span class="keywordflow">not</span> verbose <span class="keywordflow">and</span> warnings:</div> <div class="line"><a id="l00333" name="l00333"></a><span class="lineno"> 333</span> result_text += f<span class="stringliteral">"\n💡 Use verbose=true to see detailed warnings"</span></div> <div class="line"><a id="l00334" name="l00334"></a><span class="lineno"> 334</span> </div> <div class="line"><a id="l00335" name="l00335"></a><span class="lineno"> 335</span> <span class="keywordflow">return</span> result_text</div> <div class="line"><a id="l00336" name="l00336"></a><span class="lineno"> 336</span> <span class="keywordflow">else</span>:</div> <div class="line"><a id="l00337" name="l00337"></a><span class="lineno"> 337</span> error_output = result.stderr <span class="keywordflow">or</span> result.stdout</div> <div class="line"><a id="l00338" name="l00338"></a><span class="lineno"> 338</span> <span class="keywordflow">return</span> f<span class="stringliteral">"❌ Documentation generation failed:\n{error_output}"</span></div> <div class="line"><a id="l00339" name="l00339"></a><span class="lineno"> 339</span> </div> <div class="line"><a id="l00340" name="l00340"></a><span class="lineno"> 340</span> <span class="keywordflow">except</span> Exception <span class="keyword">as</span> e:</div> <div class="line"><a id="l00341" name="l00341"></a><span class="lineno"> 341</span> <span class="keywordflow">return</span> f<span class="stringliteral">"❌ Error generating documentation: {str(e)}"</span></div> <div class="line"><a id="l00342" name="l00342"></a><span class="lineno"> 342</span> </div> <div class="line"><a id="l00343" name="l00343"></a><span class="lineno"> 343</span><span class="preprocessor">@mcp.tool()</span></div> </div> <div class="foldopen" id="foldopen00344" data-start="" data-end=""> <div class="line"><a id="l00344" name="l00344"></a><span class="lineno"><a class="line" href="namespacedoxygen__mcp_1_1server.html#a35b2b9865417c2e4e5578eabf722985b"> 344</a></span><span class="keyword">async def </span><a class="code hl_function" href="namespacedoxygen__mcp_1_1server.html#a35b2b9865417c2e4e5578eabf722985b">scan_project</a>(</div> <div class="line"><a id="l00345" name="l00345"></a><span class="lineno"> 345</span> project_path: str,</div> <div class="line"><a id="l00346" name="l00346"></a><span class="lineno"> 346</span>) -> str:</div> <div class="line"><a id="l00347" name="l00347"></a><span class="lineno"> 347</span> <span class="stringliteral">"""Analyze project structure and identify documentation opportunities"""</span></div> <div class="line"><a id="l00348" name="l00348"></a><span class="lineno"> 348</span> project_path = Path(project_path)</div> <div class="line"><a id="l00349" name="l00349"></a><span class="lineno"> 349</span> </div> <div class="line"><a id="l00350" name="l00350"></a><span class="lineno"> 350</span> <span class="keywordflow">if</span> <span class="keywordflow">not</span> project_path.exists():</div> <div class="line"><a id="l00351" name="l00351"></a><span class="lineno"> 351</span> <span class="keywordflow">return</span> f<span class="stringliteral">"❌ Project path does not exist: {project_path}"</span></div> <div class="line"><a id="l00352" name="l00352"></a><span class="lineno"> 352</span> </div> <div class="line"><a id="l00353" name="l00353"></a><span class="lineno"> 353</span> <span class="keywordflow">try</span>:</div> <div class="line"><a id="l00354" name="l00354"></a><span class="lineno"> 354</span> <span class="comment"># Count files by extension</span></div> <div class="line"><a id="l00355" name="l00355"></a><span class="lineno"> 355</span> extensions = {}</div> <div class="line"><a id="l00356" name="l00356"></a><span class="lineno"> 356</span> total_files = 0</div> <div class="line"><a id="l00357" name="l00357"></a><span class="lineno"> 357</span> </div> <div class="line"><a id="l00358" name="l00358"></a><span class="lineno"> 358</span> <span class="keywordflow">for</span> file_path <span class="keywordflow">in</span> project_path.rglob(<span class="stringliteral">"*"</span>):</div> <div class="line"><a id="l00359" name="l00359"></a><span class="lineno"> 359</span> <span class="keywordflow">if</span> file_path.is_file():</div> <div class="line"><a id="l00360" name="l00360"></a><span class="lineno"> 360</span> ext = file_path.suffix.lower()</div> <div class="line"><a id="l00361" name="l00361"></a><span class="lineno"> 361</span> <span class="keywordflow">if</span> ext:</div> <div class="line"><a id="l00362" name="l00362"></a><span class="lineno"> 362</span> extensions[ext] = extensions.get(ext, 0) + 1</div> <div class="line"><a id="l00363" name="l00363"></a><span class="lineno"> 363</span> total_files += 1</div> <div class="line"><a id="l00364" name="l00364"></a><span class="lineno"> 364</span> </div> <div class="line"><a id="l00365" name="l00365"></a><span class="lineno"> 365</span> <span class="comment"># Sort by frequency</span></div> <div class="line"><a id="l00366" name="l00366"></a><span class="lineno"> 366</span> sorted_extensions = sorted(extensions.items(), key=<span class="keyword">lambda</span> x: x[1], reverse=<span class="keyword">True</span>)</div> <div class="line"><a id="l00367" name="l00367"></a><span class="lineno"> 367</span> </div> <div class="line"><a id="l00368" name="l00368"></a><span class="lineno"> 368</span> result_text = f<span class="stringliteral">"""📁 Project Scan Results for: {project_path}</span></div> <div class="line"><a id="l00369" name="l00369"></a><span class="lineno"> 369</span><span class="stringliteral">📊 Total Files Found: {total_files}</span></div> <div class="line"><a id="l00370" name="l00370"></a><span class="lineno"> 370</span><span class="stringliteral"></span> </div> <div class="line"><a id="l00371" name="l00371"></a><span class="lineno"> 371</span><span class="stringliteral">📋 Files by Type:</span></div> <div class="line"><a id="l00372" name="l00372"></a><span class="lineno"> 372</span><span class="stringliteral">"""</span></div> <div class="line"><a id="l00373" name="l00373"></a><span class="lineno"> 373</span> </div> <div class="line"><a id="l00374" name="l00374"></a><span class="lineno"> 374</span> <span class="keywordflow">for</span> ext, count <span class="keywordflow">in</span> sorted_extensions[:15]: <span class="comment"># Show top 15 extensions</span></div> <div class="line"><a id="l00375" name="l00375"></a><span class="lineno"> 375</span> result_text += f<span class="stringliteral">" 📄 {ext}: {count} files\n"</span></div> <div class="line"><a id="l00376" name="l00376"></a><span class="lineno"> 376</span> </div> <div class="line"><a id="l00377" name="l00377"></a><span class="lineno"> 377</span> <span class="keywordflow">return</span> result_text</div> <div class="line"><a id="l00378" name="l00378"></a><span class="lineno"> 378</span> </div> <div class="line"><a id="l00379" name="l00379"></a><span class="lineno"> 379</span> <span class="keywordflow">except</span> Exception <span class="keyword">as</span> e:</div> <div class="line"><a id="l00380" name="l00380"></a><span class="lineno"> 380</span> <span class="keywordflow">return</span> f<span class="stringliteral">"❌ Error scanning project: {str(e)}"</span></div> <div class="line"><a id="l00381" name="l00381"></a><span class="lineno"> 381</span> </div> <div class="line"><a id="l00382" name="l00382"></a><span class="lineno"> 382</span><span class="preprocessor">@mcp.tool()</span></div> </div> <div class="foldopen" id="foldopen00383" data-start="" data-end=""> <div class="line"><a id="l00383" name="l00383"></a><span class="lineno"><a class="line" href="namespacedoxygen__mcp_1_1server.html#a9472b5af1271de553243057e15e66311"> 383</a></span><span class="keyword">async def </span><a class="code hl_function" href="namespacedoxygen__mcp_1_1server.html#a9472b5af1271de553243057e15e66311">validate_documentation</a>(</div> <div class="line"><a id="l00384" name="l00384"></a><span class="lineno"> 384</span> project_path: str,</div> <div class="line"><a id="l00385" name="l00385"></a><span class="lineno"> 385</span> check_coverage: bool = <span class="keyword">True</span>,</div> <div class="line"><a id="l00386" name="l00386"></a><span class="lineno"> 386</span> warn_undocumented: bool = <span class="keyword">True</span>,</div> <div class="line"><a id="l00387" name="l00387"></a><span class="lineno"> 387</span> output_format: str = <span class="stringliteral">"text"</span>,</div> <div class="line"><a id="l00388" name="l00388"></a><span class="lineno"> 388</span>) -> str:</div> <div class="line"><a id="l00389" name="l00389"></a><span class="lineno"> 389</span> <span class="stringliteral">"""Check for documentation warnings, missing docs, and coverage analysis"""</span></div> <div class="line"><a id="l00390" name="l00390"></a><span class="lineno"> 390</span> <span class="keywordflow">return</span> <span class="stringliteral">"🚧 Documentation validation coming soon!"</span></div> <div class="line"><a id="l00391" name="l00391"></a><span class="lineno"> 391</span> </div> <div class="line"><a id="l00392" name="l00392"></a><span class="lineno"> 392</span><span class="preprocessor">@mcp.tool()</span></div> </div> <div class="foldopen" id="foldopen00393" data-start="" data-end=""> <div class="line"><a id="l00393" name="l00393"></a><span class="lineno"><a class="line" href="namespacedoxygen__mcp_1_1server.html#add05b8030cb0f38b92abae62f9b18b86"> 393</a></span><span class="keyword">async def </span><a class="code hl_function" href="namespacedoxygen__mcp_1_1server.html#add05b8030cb0f38b92abae62f9b18b86">create_doxyfile</a>(</div> <div class="line"><a id="l00394" name="l00394"></a><span class="lineno"> 394</span> output_path: str,</div> <div class="line"><a id="l00395" name="l00395"></a><span class="lineno"> 395</span> template: str = <span class="stringliteral">"standard"</span>,</div> <div class="line"><a id="l00396" name="l00396"></a><span class="lineno"> 396</span> project_settings: dict = {},</div> <div class="line"><a id="l00397" name="l00397"></a><span class="lineno"> 397</span> language_optimizations: list = [],</div> <div class="line"><a id="l00398" name="l00398"></a><span class="lineno"> 398</span>) -> str:</div> <div class="line"><a id="l00399" name="l00399"></a><span class="lineno"> 399</span> <span class="stringliteral">"""Generate a Doxyfile configuration with specified settings"""</span></div> <div class="line"><a id="l00400" name="l00400"></a><span class="lineno"> 400</span> <span class="keywordflow">return</span> <span class="stringliteral">"🚧 Create Doxyfile functionality coming soon!"</span></div> <div class="line"><a id="l00401" name="l00401"></a><span class="lineno"> 401</span> </div> <div class="line"><a id="l00402" name="l00402"></a><span class="lineno"> 402</span><span class="preprocessor">@mcp.tool()</span></div> </div> <div class="foldopen" id="foldopen00403" data-start="" data-end=""> <div class="line"><a id="l00403" name="l00403"></a><span class="lineno"><a class="line" href="namespacedoxygen__mcp_1_1server.html#a59adf8cd9644737fde2a4d67112c83a9"> 403</a></span><span class="keyword">async def </span><a class="code hl_function" href="namespacedoxygen__mcp_1_1server.html#a59adf8cd9644737fde2a4d67112c83a9">check_doxygen_install</a>(</div> <div class="line"><a id="l00404" name="l00404"></a><span class="lineno"> 404</span> check_dot: bool = <span class="keyword">True</span>,</div> <div class="line"><a id="l00405" name="l00405"></a><span class="lineno"> 405</span> check_latex: bool = <span class="keyword">True</span>,</div> <div class="line"><a id="l00406" name="l00406"></a><span class="lineno"> 406</span> detailed: bool = <span class="keyword">False</span>,</div> <div class="line"><a id="l00407" name="l00407"></a><span class="lineno"> 407</span>) -> str:</div> <div class="line"><a id="l00408" name="l00408"></a><span class="lineno"> 408</span> <span class="stringliteral">"""Verify Doxygen installation and capabilities"""</span></div> <div class="line"><a id="l00409" name="l00409"></a><span class="lineno"> 409</span> <span class="keywordflow">try</span>:</div> <div class="line"><a id="l00410" name="l00410"></a><span class="lineno"> 410</span> result = subprocess.run([<span class="stringliteral">"doxygen"</span>, <span class="stringliteral">"--version"</span>], capture_output=<span class="keyword">True</span>, text=<span class="keyword">True</span>)</div> <div class="line"><a id="l00411" name="l00411"></a><span class="lineno"> 411</span> <span class="keywordflow">if</span> result.returncode == 0:</div> <div class="line"><a id="l00412" name="l00412"></a><span class="lineno"> 412</span> version = result.stdout.strip()</div> <div class="line"><a id="l00413" name="l00413"></a><span class="lineno"> 413</span> <span class="keywordflow">return</span> f<span class="stringliteral">"✅ Doxygen {version} is installed and working!"</span></div> <div class="line"><a id="l00414" name="l00414"></a><span class="lineno"> 414</span> <span class="keywordflow">else</span>:</div> <div class="line"><a id="l00415" name="l00415"></a><span class="lineno"> 415</span> <span class="keywordflow">return</span> <span class="stringliteral">"❌ Doxygen is not working properly"</span></div> <div class="line"><a id="l00416" name="l00416"></a><span class="lineno"> 416</span> <span class="keywordflow">except</span> FileNotFoundError:</div> <div class="line"><a id="l00417" name="l00417"></a><span class="lineno"> 417</span> <span class="keywordflow">return</span> <span class="stringliteral">"❌ Doxygen is not installed"</span></div> <div class="line"><a id="l00418" name="l00418"></a><span class="lineno"> 418</span> </div> <div class="line"><a id="l00419" name="l00419"></a><span class="lineno"> 419</span><span class="preprocessor">@mcp.tool()</span></div> </div> <div class="foldopen" id="foldopen00420" data-start="" data-end=""> <div class="line"><a id="l00420" name="l00420"></a><span class="lineno"><a class="line" href="namespacedoxygen__mcp_1_1server.html#a4d3dbe0428ffe2d0bf544b4bf4307029"> 420</a></span><span class="keyword">async def </span><a class="code hl_function" href="namespacedoxygen__mcp_1_1server.html#a4d3dbe0428ffe2d0bf544b4bf4307029">suggest_file_patterns</a>(</div> <div class="line"><a id="l00421" name="l00421"></a><span class="lineno"> 421</span> project_path: str,</div> <div class="line"><a id="l00422" name="l00422"></a><span class="lineno"> 422</span> primary_language: str = <span class="stringliteral">""</span>,</div> <div class="line"><a id="l00423" name="l00423"></a><span class="lineno"> 423</span> include_tests: bool = <span class="keyword">False</span>,</div> <div class="line"><a id="l00424" name="l00424"></a><span class="lineno"> 424</span> include_examples: bool = <span class="keyword">True</span>,</div> <div class="line"><a id="l00425" name="l00425"></a><span class="lineno"> 425</span>) -> str:</div> <div class="line"><a id="l00426" name="l00426"></a><span class="lineno"> 426</span> <span class="stringliteral">"""Suggest appropriate file patterns for a project"""</span></div> <div class="line"><a id="l00427" name="l00427"></a><span class="lineno"> 427</span> project_path = Path(project_path)</div> <div class="line"><a id="l00428" name="l00428"></a><span class="lineno"> 428</span> </div> <div class="line"><a id="l00429" name="l00429"></a><span class="lineno"> 429</span> <span class="keywordflow">if</span> <span class="keywordflow">not</span> project_path.exists():</div> <div class="line"><a id="l00430" name="l00430"></a><span class="lineno"> 430</span> <span class="keywordflow">return</span> f<span class="stringliteral">"❌ Project path does not exist: {project_path}"</span></div> <div class="line"><a id="l00431" name="l00431"></a><span class="lineno"> 431</span> </div> <div class="line"><a id="l00432" name="l00432"></a><span class="lineno"> 432</span> <span class="keywordflow">try</span>:</div> <div class="line"><a id="l00433" name="l00433"></a><span class="lineno"> 433</span> <span class="comment"># Analyze actual files in the project</span></div> <div class="line"><a id="l00434" name="l00434"></a><span class="lineno"> 434</span> extensions = {}</div> <div class="line"><a id="l00435" name="l00435"></a><span class="lineno"> 435</span> <span class="keywordflow">for</span> file_path <span class="keywordflow">in</span> project_path.rglob(<span class="stringliteral">"*"</span>):</div> <div class="line"><a id="l00436" name="l00436"></a><span class="lineno"> 436</span> <span class="keywordflow">if</span> file_path.is_file():</div> <div class="line"><a id="l00437" name="l00437"></a><span class="lineno"> 437</span> ext = file_path.suffix.lower()</div> <div class="line"><a id="l00438" name="l00438"></a><span class="lineno"> 438</span> <span class="keywordflow">if</span> ext:</div> <div class="line"><a id="l00439" name="l00439"></a><span class="lineno"> 439</span> extensions[ext] = extensions.get(ext, 0) + 1</div> <div class="line"><a id="l00440" name="l00440"></a><span class="lineno"> 440</span> </div> <div class="line"><a id="l00441" name="l00441"></a><span class="lineno"> 441</span> <span class="comment"># Language-specific pattern suggestions</span></div> <div class="line"><a id="l00442" name="l00442"></a><span class="lineno"> 442</span> language_patterns = {</div> <div class="line"><a id="l00443" name="l00443"></a><span class="lineno"> 443</span> <span class="stringliteral">"c"</span>: [<span class="stringliteral">"*.c"</span>, <span class="stringliteral">"*.h"</span>],</div> <div class="line"><a id="l00444" name="l00444"></a><span class="lineno"> 444</span> <span class="stringliteral">"cpp"</span>: [<span class="stringliteral">"*.cpp"</span>, <span class="stringliteral">"*.cxx"</span>, <span class="stringliteral">"*.cc"</span>, <span class="stringliteral">"*.C"</span>, <span class="stringliteral">"*.hpp"</span>, <span class="stringliteral">"*.hxx"</span>, <span class="stringliteral">"*.hh"</span>, <span class="stringliteral">"*.H"</span>],</div> <div class="line"><a id="l00445" name="l00445"></a><span class="lineno"> 445</span> <span class="stringliteral">"python"</span>: [<span class="stringliteral">"*.py"</span>, <span class="stringliteral">"*.pyx"</span>, <span class="stringliteral">"*.pyi"</span>],</div> <div class="line"><a id="l00446" name="l00446"></a><span class="lineno"> 446</span> <span class="stringliteral">"java"</span>: [<span class="stringliteral">"*.java"</span>],</div> <div class="line"><a id="l00447" name="l00447"></a><span class="lineno"> 447</span> <span class="stringliteral">"php"</span>: [<span class="stringliteral">"*.php"</span>, <span class="stringliteral">"*.php3"</span>, <span class="stringliteral">"*.inc"</span>],</div> <div class="line"><a id="l00448" name="l00448"></a><span class="lineno"> 448</span> <span class="stringliteral">"javascript"</span>: [<span class="stringliteral">"*.js"</span>, <span class="stringliteral">"*.jsx"</span>, <span class="stringliteral">"*.ts"</span>, <span class="stringliteral">"*.tsx"</span>],</div> <div class="line"><a id="l00449" name="l00449"></a><span class="lineno"> 449</span> <span class="stringliteral">"csharp"</span>: [<span class="stringliteral">"*.cs"</span>],</div> <div class="line"><a id="l00450" name="l00450"></a><span class="lineno"> 450</span> <span class="stringliteral">"go"</span>: [<span class="stringliteral">"*.go"</span>],</div> <div class="line"><a id="l00451" name="l00451"></a><span class="lineno"> 451</span> <span class="stringliteral">"rust"</span>: [<span class="stringliteral">"*.rs"</span>]</div> <div class="line"><a id="l00452" name="l00452"></a><span class="lineno"> 452</span> }</div> <div class="line"><a id="l00453" name="l00453"></a><span class="lineno"> 453</span> </div> <div class="line"><a id="l00454" name="l00454"></a><span class="lineno"> 454</span> <span class="comment"># Build suggestions based on found files and language</span></div> <div class="line"><a id="l00455" name="l00455"></a><span class="lineno"> 455</span> suggested_patterns = []</div> <div class="line"><a id="l00456" name="l00456"></a><span class="lineno"> 456</span> </div> <div class="line"><a id="l00457" name="l00457"></a><span class="lineno"> 457</span> <span class="keywordflow">if</span> primary_language.lower() <span class="keywordflow">in</span> language_patterns:</div> <div class="line"><a id="l00458" name="l00458"></a><span class="lineno"> 458</span> suggested_patterns.extend(language_patterns[primary_language.lower()])</div> <div class="line"><a id="l00459" name="l00459"></a><span class="lineno"> 459</span> </div> <div class="line"><a id="l00460" name="l00460"></a><span class="lineno"> 460</span> <span class="comment"># Add patterns based on actual files found</span></div> <div class="line"><a id="l00461" name="l00461"></a><span class="lineno"> 461</span> common_source_extensions = {</div> <div class="line"><a id="l00462" name="l00462"></a><span class="lineno"> 462</span> <span class="stringliteral">".c"</span>, <span class="stringliteral">".cpp"</span>, <span class="stringliteral">".cxx"</span>, <span class="stringliteral">".cc"</span>, <span class="stringliteral">".h"</span>, <span class="stringliteral">".hpp"</span>, <span class="stringliteral">".hxx"</span>, <span class="stringliteral">".hh"</span>,</div> <div class="line"><a id="l00463" name="l00463"></a><span class="lineno"> 463</span> <span class="stringliteral">".py"</span>, <span class="stringliteral">".java"</span>, <span class="stringliteral">".php"</span>, <span class="stringliteral">".js"</span>, <span class="stringliteral">".jsx"</span>, <span class="stringliteral">".ts"</span>, <span class="stringliteral">".tsx"</span>,</div> <div class="line"><a id="l00464" name="l00464"></a><span class="lineno"> 464</span> <span class="stringliteral">".cs"</span>, <span class="stringliteral">".go"</span>, <span class="stringliteral">".rs"</span>, <span class="stringliteral">".rb"</span>, <span class="stringliteral">".pl"</span>, <span class="stringliteral">".sh"</span></div> <div class="line"><a id="l00465" name="l00465"></a><span class="lineno"> 465</span> }</div> <div class="line"><a id="l00466" name="l00466"></a><span class="lineno"> 466</span> </div> <div class="line"><a id="l00467" name="l00467"></a><span class="lineno"> 467</span> <span class="keywordflow">for</span> ext <span class="keywordflow">in</span> extensions:</div> <div class="line"><a id="l00468" name="l00468"></a><span class="lineno"> 468</span> <span class="keywordflow">if</span> ext <span class="keywordflow">in</span> common_source_extensions:</div> <div class="line"><a id="l00469" name="l00469"></a><span class="lineno"> 469</span> pattern = f<span class="stringliteral">"*{ext}"</span></div> <div class="line"><a id="l00470" name="l00470"></a><span class="lineno"> 470</span> <span class="keywordflow">if</span> pattern <span class="keywordflow">not</span> <span class="keywordflow">in</span> suggested_patterns:</div> <div class="line"><a id="l00471" name="l00471"></a><span class="lineno"> 471</span> suggested_patterns.append(pattern)</div> <div class="line"><a id="l00472" name="l00472"></a><span class="lineno"> 472</span> </div> <div class="line"><a id="l00473" name="l00473"></a><span class="lineno"> 473</span> <span class="comment"># Optional patterns</span></div> <div class="line"><a id="l00474" name="l00474"></a><span class="lineno"> 474</span> optional_patterns = []</div> <div class="line"><a id="l00475" name="l00475"></a><span class="lineno"> 475</span> <span class="keywordflow">if</span> include_examples <span class="keywordflow">and</span> any(ext <span class="keywordflow">in</span> [<span class="stringliteral">".md"</span>, <span class="stringliteral">".txt"</span>, <span class="stringliteral">".rst"</span>] <span class="keywordflow">for</span> ext <span class="keywordflow">in</span> extensions):</div> <div class="line"><a id="l00476" name="l00476"></a><span class="lineno"> 476</span> optional_patterns.extend([<span class="stringliteral">"*.md"</span>, <span class="stringliteral">"*.txt"</span>, <span class="stringliteral">".rst"</span>])</div> <div class="line"><a id="l00477" name="l00477"></a><span class="lineno"> 477</span> </div> <div class="line"><a id="l00478" name="l00478"></a><span class="lineno"> 478</span> <span class="keywordflow">if</span> include_tests:</div> <div class="line"><a id="l00479" name="l00479"></a><span class="lineno"> 479</span> optional_patterns.extend([<span class="stringliteral">"test_*.py"</span>, <span class="stringliteral">"*_test.cpp"</span>, <span class="stringliteral">"Test*.java"</span>])</div> <div class="line"><a id="l00480" name="l00480"></a><span class="lineno"> 480</span> </div> <div class="line"><a id="l00481" name="l00481"></a><span class="lineno"> 481</span> result_text = f<span class="stringliteral">"""📋 File Pattern Suggestions for: {project_path}</span></div> <div class="line"><a id="l00482" name="l00482"></a><span class="lineno"> 482</span><span class="stringliteral"></span> </div> <div class="line"><a id="l00483" name="l00483"></a><span class="lineno"> 483</span><span class="stringliteral">🎯 Recommended Patterns:</span></div> <div class="line"><a id="l00484" name="l00484"></a><span class="lineno"> 484</span><span class="stringliteral">{chr(10).join(f" 📄 {pattern}" for pattern in suggested_patterns)}</span></div> <div class="line"><a id="l00485" name="l00485"></a><span class="lineno"> 485</span><span class="stringliteral"></span> </div> <div class="line"><a id="l00486" name="l00486"></a><span class="lineno"> 486</span><span class="stringliteral">📊 Found Extensions:</span></div> <div class="line"><a id="l00487" name="l00487"></a><span class="lineno"> 487</span><span class="stringliteral">{chr(10).join(f" {ext}: {count} files" for ext, count in sorted(extensions.items(), key=lambda x: x[1], reverse=True)[:10])}</span></div> <div class="line"><a id="l00488" name="l00488"></a><span class="lineno"> 488</span><span class="stringliteral">"""</span></div> <div class="line"><a id="l00489" name="l00489"></a><span class="lineno"> 489</span> </div> <div class="line"><a id="l00490" name="l00490"></a><span class="lineno"> 490</span> <span class="keywordflow">if</span> optional_patterns:</div> <div class="line"><a id="l00491" name="l00491"></a><span class="lineno"> 491</span> result_text += f<span class="stringliteral">"\n🔧 Optional Patterns:\n{chr(10).join(f' 📄 {pattern}' for pattern in optional_patterns)}"</span></div> <div class="line"><a id="l00492" name="l00492"></a><span class="lineno"> 492</span> </div> <div class="line"><a id="l00493" name="l00493"></a><span class="lineno"> 493</span> result_text += f<span class="stringliteral">"\n\n💡 Add these patterns to your Doxyfile:\nFILE_PATTERNS = {' '.join(suggested_patterns)}"</span></div> <div class="line"><a id="l00494" name="l00494"></a><span class="lineno"> 494</span> </div> <div class="line"><a id="l00495" name="l00495"></a><span class="lineno"> 495</span> <span class="keywordflow">return</span> result_text</div> <div class="line"><a id="l00496" name="l00496"></a><span class="lineno"> 496</span> </div> <div class="line"><a id="l00497" name="l00497"></a><span class="lineno"> 497</span> <span class="keywordflow">except</span> Exception <span class="keyword">as</span> e:</div> <div class="line"><a id="l00498" name="l00498"></a><span class="lineno"> 498</span> <span class="keywordflow">return</span> f<span class="stringliteral">"❌ Error analyzing patterns: {str(e)}"</span></div> <div class="line"><a id="l00499" name="l00499"></a><span class="lineno"> 499</span> </div> </div> <div class="foldopen" id="foldopen00500" data-start="" data-end=""> <div class="line"><a id="l00500" name="l00500"></a><span class="lineno"><a class="line" href="namespacedoxygen__mcp_1_1server.html#a7200d238798fee09e5bf9611e578483b"> 500</a></span><span class="keyword">def </span><a class="code hl_function" href="namespacedoxygen__mcp_1_1server.html#a7200d238798fee09e5bf9611e578483b">main</a>():</div> <div class="line"><a id="l00501" name="l00501"></a><span class="lineno"> 501</span> <span class="stringliteral">"""Main entry point for the Doxygen MCP server"""</span></div> <div class="line"><a id="l00502" name="l00502"></a><span class="lineno"> 502</span><span class="stringliteral"> mcp.run()</span></div> <div class="line"><a id="l00503" name="l00503"></a><span class="lineno"> 503</span><span class="stringliteral"></span> </div> </div> <div class="line"><a id="l00504" name="l00504"></a><span class="lineno"> 504</span><span class="stringliteral">if __name__ == "__main__":</span></div> <div class="line"><a id="l00505" name="l00505"></a><span class="lineno"> 505</span><span class="stringliteral"> main()</span></div> <div class="ttc" id="aclassdoxygen__mcp_1_1server_1_1_doxygen_config_html"><div class="ttname"><a href="classdoxygen__mcp_1_1server_1_1_doxygen_config.html">doxygen_mcp.server.DoxygenConfig</a></div><div class="ttdef"><b>Definition</b> <a href="#l00049">server.py:49</a></div></div> <div class="ttc" id="aclassdoxygen__mcp_1_1server_1_1_doxygen_config_html_a173bcfefcfd37eceb942aab59bda1f7a"><div class="ttname"><a href="classdoxygen__mcp_1_1server_1_1_doxygen_config.html#a173bcfefcfd37eceb942aab59bda1f7a">doxygen_mcp.server.DoxygenConfig.exclude_patterns</a></div><div class="ttdeci">list exclude_patterns</div><div class="ttdef"><b>Definition</b> <a href="#l00085">server.py:85</a></div></div> <div class="ttc" id="aclassdoxygen__mcp_1_1server_1_1_doxygen_config_html_a5ae77c0455aee3e6a2adbc3d4d6cbe66"><div class="ttname"><a href="classdoxygen__mcp_1_1server_1_1_doxygen_config.html#a5ae77c0455aee3e6a2adbc3d4d6cbe66">doxygen_mcp.server.DoxygenConfig.to_doxyfile</a></div><div class="ttdeci">str to_doxyfile(self)</div><div class="ttdef"><b>Definition</b> <a href="#l00123">server.py:123</a></div></div> <div class="ttc" id="anamespacedoxygen__mcp_1_1server_html_a219b291d78942e6529d5d14a29afb3cd"><div class="ttname"><a href="namespacedoxygen__mcp_1_1server.html#a219b291d78942e6529d5d14a29afb3cd">doxygen_mcp.server.create_doxygen_project</a></div><div class="ttdeci">str create_doxygen_project(str project_name, str project_path, str language="mixed", bool include_subdirs=True, bool extract_private=False)</div><div class="ttdef"><b>Definition</b> <a href="#l00197">server.py:203</a></div></div> <div class="ttc" id="anamespacedoxygen__mcp_1_1server_html_a35b2b9865417c2e4e5578eabf722985b"><div class="ttname"><a href="namespacedoxygen__mcp_1_1server.html#a35b2b9865417c2e4e5578eabf722985b">doxygen_mcp.server.scan_project</a></div><div class="ttdeci">str scan_project(str project_path)</div><div class="ttdef"><b>Definition</b> <a href="#l00344">server.py:346</a></div></div> <div class="ttc" id="anamespacedoxygen__mcp_1_1server_html_a4d3dbe0428ffe2d0bf544b4bf4307029"><div class="ttname"><a href="namespacedoxygen__mcp_1_1server.html#a4d3dbe0428ffe2d0bf544b4bf4307029">doxygen_mcp.server.suggest_file_patterns</a></div><div class="ttdeci">str suggest_file_patterns(str project_path, str primary_language="", bool include_tests=False, bool include_examples=True)</div><div class="ttdef"><b>Definition</b> <a href="#l00420">server.py:425</a></div></div> <div class="ttc" id="anamespacedoxygen__mcp_1_1server_html_a59adf8cd9644737fde2a4d67112c83a9"><div class="ttname"><a href="namespacedoxygen__mcp_1_1server.html#a59adf8cd9644737fde2a4d67112c83a9">doxygen_mcp.server.check_doxygen_install</a></div><div class="ttdeci">str check_doxygen_install(bool check_dot=True, bool check_latex=True, bool detailed=False)</div><div class="ttdef"><b>Definition</b> <a href="#l00403">server.py:407</a></div></div> <div class="ttc" id="anamespacedoxygen__mcp_1_1server_html_a7200d238798fee09e5bf9611e578483b"><div class="ttname"><a href="namespacedoxygen__mcp_1_1server.html#a7200d238798fee09e5bf9611e578483b">doxygen_mcp.server.main</a></div><div class="ttdeci">main()</div><div class="ttdef"><b>Definition</b> <a href="#l00500">server.py:500</a></div></div> <div class="ttc" id="anamespacedoxygen__mcp_1_1server_html_a9472b5af1271de553243057e15e66311"><div class="ttname"><a href="namespacedoxygen__mcp_1_1server.html#a9472b5af1271de553243057e15e66311">doxygen_mcp.server.validate_documentation</a></div><div class="ttdeci">str validate_documentation(str project_path, bool check_coverage=True, bool warn_undocumented=True, str output_format="text")</div><div class="ttdef"><b>Definition</b> <a href="#l00383">server.py:388</a></div></div> <div class="ttc" id="anamespacedoxygen__mcp_1_1server_html_add05b8030cb0f38b92abae62f9b18b86"><div class="ttname"><a href="namespacedoxygen__mcp_1_1server.html#add05b8030cb0f38b92abae62f9b18b86">doxygen_mcp.server.create_doxyfile</a></div><div class="ttdeci">str create_doxyfile(str output_path, str template="standard", dict project_settings={}, list language_optimizations=[])</div><div class="ttdef"><b>Definition</b> <a href="#l00393">server.py:398</a></div></div> <div class="ttc" id="anamespacedoxygen__mcp_1_1server_html_af54109e1fe48151097551d8b6514733a"><div class="ttname"><a href="namespacedoxygen__mcp_1_1server.html#af54109e1fe48151097551d8b6514733a">doxygen_mcp.server.generate_documentation</a></div><div class="ttdeci">str generate_documentation(str project_path, str output_format="html", bool clean_output=True, bool verbose=False)</div><div class="ttdef"><b>Definition</b> <a href="#l00275">server.py:280</a></div></div> </div></div> </div> </div>  <div id="nav-path" class="navpath"> <ul> <li class="navelem"><a href="dir_5fc0168d11760b9445bd29fa15d9290f.html">dev</a></li><li class="navelem"><a href="dir_93f11e488ba28673d1e4cf44bdec4b06.html">ARTIFICIAL_INTELLIGENCE</a></li><li class="navelem"><a href="dir_d49abdd7eb3db7947fc47a0732983464.html">MCP</a></li><li class="navelem"><a href="dir_7a1e2bf759eac6f8c037e45246da61e7.html">doxygen-mcp</a></li><li class="navelem"><a href="dir_172d5dfda4915b7c4f6e9ccccdc5dc90.html">src</a></li><li class="navelem"><a href="dir_fa3dd1b78950c7f654f6c2080840933e.html">doxygen_mcp</a></li><li class="navelem"><a href="server_8py.html">server.py</a></li> <li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.15.0 </li> </ul> </div> </body> </html>

Loading blob content...

Latest Blog Posts

Don't Use Large Strings as Cache Keys
By punkpeye on January 11, 2026.
markdown
node-js
cache
What are Claude Skills?
By punkpeye on January 10, 2026.
mcp
skills
How to Test MCP Streamable HTTP Endpoints Using cURL
By punkpeye on January 2, 2026.
tutorial
bash

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/Positronikal/doxygen-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server

server_8py_source.html•102 kB