Skip to main content
Glama
index.html27.4 kB
<!doctype html> <html lang="en" class="no-js"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width,initial-scale=1"> <link rel="prev" href="../cli/"> <link rel="next" href="../core/"> <link rel="icon" href="../assets/images/favicon.png"> <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.21"> <title>Server - CodeGraphContext</title> <link rel="stylesheet" href="../assets/stylesheets/main.2a3383ac.min.css"> <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin> <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback"> <style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style> <script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script> </head> <body dir="ltr"> <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off"> <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off"> <label class="md-overlay" for="__drawer"></label> <div data-md-component="skip"> <a href="#mcpserver" class="md-skip"> Skip to content </a> </div> <div data-md-component="announce"> </div> <header class="md-header md-header--shadow" data-md-component="header"> <nav class="md-header__inner md-grid" aria-label="Header"> <a href=".." title="CodeGraphContext" class="md-header__button md-logo" aria-label="CodeGraphContext" data-md-component="logo"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg> </a> <label class="md-header__button md-icon" for="__drawer"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg> </label> <div class="md-header__title" data-md-component="header-title"> <div class="md-header__ellipsis"> <div class="md-header__topic"> <span class="md-ellipsis"> CodeGraphContext </span> </div> <div class="md-header__topic" data-md-component="header-topic"> <span class="md-ellipsis"> Server </span> </div> </div> </div> <script>var palette=__md_get("__palette");if(palette&&palette.color){if("(prefers-color-scheme)"===palette.color.media){var media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent")}for(var[key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script> <label class="md-header__button md-icon" for="__search"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg> </label> <div class="md-search" data-md-component="search" role="dialog"> <label class="md-search__overlay" for="__search"></label> <div class="md-search__inner" role="search"> <form class="md-search__form" name="search"> <input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required> <label class="md-search__icon md-icon" for="__search"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg> </label> <nav class="md-search__options" aria-label="Search"> <button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"/></svg> </button> </nav> </form> <div class="md-search__output"> <div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix> <div class="md-search-result" data-md-component="search-result"> <div class="md-search-result__meta"> Initializing search </div> <ol class="md-search-result__list" role="presentation"></ol> </div> </div> </div> </div> </div> </nav> </header> <div class="md-container" data-md-component="container"> <main class="md-main" data-md-component="main"> <div class="md-main__inner md-grid"> <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" > <div class="md-sidebar__scrollwrap"> <div class="md-sidebar__inner"> <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0"> <label class="md-nav__title" for="__drawer"> <a href=".." title="CodeGraphContext" class="md-nav__button md-logo" aria-label="CodeGraphContext" data-md-component="logo"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg> </a> CodeGraphContext </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href=".." class="md-nav__link"> <span class="md-ellipsis"> Home </span> </a> </li> <li class="md-nav__item"> <a href="../installation/" class="md-nav__link"> <span class="md-ellipsis"> Installation </span> </a> </li> <li class="md-nav__item"> <a href="../use_cases/" class="md-nav__link"> <span class="md-ellipsis"> Use Cases </span> </a> </li> <li class="md-nav__item"> <a href="../architecture/" class="md-nav__link"> <span class="md-ellipsis"> Architecture </span> </a> </li> <li class="md-nav__item"> <a href="../cli/" class="md-nav__link"> <span class="md-ellipsis"> CLI Reference </span> </a> </li> <li class="md-nav__item md-nav__item--active"> <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc"> <label class="md-nav__link md-nav__link--active" for="__toc"> <span class="md-ellipsis"> Server </span> <span class="md-nav__icon md-icon"></span> </label> <a href="./" class="md-nav__link md-nav__link--active"> <span class="md-ellipsis"> Server </span> </a> <nav class="md-nav md-nav--secondary" aria-label="Table of contents"> <label class="md-nav__title" for="__toc"> <span class="md-nav__icon md-icon"></span> Table of contents </label> <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix> <li class="md-nav__item"> <a href="#initialization" class="md-nav__link"> <span class="md-ellipsis"> Initialization </span> </a> </li> <li class="md-nav__item"> <a href="#tool-manifest" class="md-nav__link"> <span class="md-ellipsis"> Tool Manifest </span> </a> <nav class="md-nav" aria-label="Tool Manifest"> <ul class="md-nav__list"> <li class="md-nav__item"> <a href="#add_code_to_graph" class="md-nav__link"> <span class="md-ellipsis"> add_code_to_graph </span> </a> </li> <li class="md-nav__item"> <a href="#check_job_status" class="md-nav__link"> <span class="md-ellipsis"> check_job_status </span> </a> </li> <li class="md-nav__item"> <a href="#list_jobs" class="md-nav__link"> <span class="md-ellipsis"> list_jobs </span> </a> </li> <li class="md-nav__item"> <a href="#find_code" class="md-nav__link"> <span class="md-ellipsis"> find_code </span> </a> </li> <li class="md-nav__item"> <a href="#analyze_code_relationships" class="md-nav__link"> <span class="md-ellipsis"> analyze_code_relationships </span> </a> </li> <li class="md-nav__item"> <a href="#watch_directory" class="md-nav__link"> <span class="md-ellipsis"> watch_directory </span> </a> </li> <li class="md-nav__item"> <a href="#execute_cypher_query" class="md-nav__link"> <span class="md-ellipsis"> execute_cypher_query </span> </a> </li> <li class="md-nav__item"> <a href="#add_package_to_graph" class="md-nav__link"> <span class="md-ellipsis"> add_package_to_graph </span> </a> </li> <li class="md-nav__item"> <a href="#find_dead_code" class="md-nav__link"> <span class="md-ellipsis"> find_dead_code </span> </a> </li> <li class="md-nav__item"> <a href="#calculate_cyclomatic_complexity" class="md-nav__link"> <span class="md-ellipsis"> calculate_cyclomatic_complexity </span> </a> </li> <li class="md-nav__item"> <a href="#find_most_complex_functions" class="md-nav__link"> <span class="md-ellipsis"> find_most_complex_functions </span> </a> </li> <li class="md-nav__item"> <a href="#list_indexed_repositories" class="md-nav__link"> <span class="md-ellipsis"> list_indexed_repositories </span> </a> </li> <li class="md-nav__item"> <a href="#delete_repository" class="md-nav__link"> <span class="md-ellipsis"> delete_repository </span> </a> </li> <li class="md-nav__item"> <a href="#visualize_graph_query" class="md-nav__link"> <span class="md-ellipsis"> visualize_graph_query </span> </a> </li> <li class="md-nav__item"> <a href="#list_watched_paths" class="md-nav__link"> <span class="md-ellipsis"> list_watched_paths </span> </a> </li> <li class="md-nav__item"> <a href="#unwatch_directory" class="md-nav__link"> <span class="md-ellipsis"> unwatch_directory </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item"> <a href="#other-methods" class="md-nav__link"> <span class="md-ellipsis"> Other Methods </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item"> <a href="../core/" class="md-nav__link"> <span class="md-ellipsis"> Core Concepts </span> </a> </li> <li class="md-nav__item"> <a href="../tools/" class="md-nav__link"> <span class="md-ellipsis"> Tools </span> </a> </li> <li class="md-nav__item"> <a href="../cookbook/" class="md-nav__link"> <span class="md-ellipsis"> Cookbook </span> </a> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_10" > <label class="md-nav__link" for="__nav_10" id="__nav_10_label" tabindex="0"> <span class="md-ellipsis"> Contributing </span> <span class="md-nav__icon md-icon"></span> </label> <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_10_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_10"> <span class="md-nav__icon md-icon"></span> Contributing </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../contributing/" class="md-nav__link"> <span class="md-ellipsis"> Overview </span> </a> </li> <li class="md-nav__item"> <a href="../contributing_languages/" class="md-nav__link"> <span class="md-ellipsis"> Adding New Languages </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item"> <a href="../troubleshooting/" class="md-nav__link"> <span class="md-ellipsis"> Troubleshooting </span> </a> </li> <li class="md-nav__item"> <a href="../future_work/" class="md-nav__link"> <span class="md-ellipsis"> Future Work </span> </a> </li> <li class="md-nav__item"> <a href="../license/" class="md-nav__link"> <span class="md-ellipsis"> License </span> </a> </li> </ul> </nav> </div> </div> </div> <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" > <div class="md-sidebar__scrollwrap"> <div class="md-sidebar__inner"> <nav class="md-nav md-nav--secondary" aria-label="Table of contents"> <label class="md-nav__title" for="__toc"> <span class="md-nav__icon md-icon"></span> Table of contents </label> <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix> <li class="md-nav__item"> <a href="#initialization" class="md-nav__link"> <span class="md-ellipsis"> Initialization </span> </a> </li> <li class="md-nav__item"> <a href="#tool-manifest" class="md-nav__link"> <span class="md-ellipsis"> Tool Manifest </span> </a> <nav class="md-nav" aria-label="Tool Manifest"> <ul class="md-nav__list"> <li class="md-nav__item"> <a href="#add_code_to_graph" class="md-nav__link"> <span class="md-ellipsis"> add_code_to_graph </span> </a> </li> <li class="md-nav__item"> <a href="#check_job_status" class="md-nav__link"> <span class="md-ellipsis"> check_job_status </span> </a> </li> <li class="md-nav__item"> <a href="#list_jobs" class="md-nav__link"> <span class="md-ellipsis"> list_jobs </span> </a> </li> <li class="md-nav__item"> <a href="#find_code" class="md-nav__link"> <span class="md-ellipsis"> find_code </span> </a> </li> <li class="md-nav__item"> <a href="#analyze_code_relationships" class="md-nav__link"> <span class="md-ellipsis"> analyze_code_relationships </span> </a> </li> <li class="md-nav__item"> <a href="#watch_directory" class="md-nav__link"> <span class="md-ellipsis"> watch_directory </span> </a> </li> <li class="md-nav__item"> <a href="#execute_cypher_query" class="md-nav__link"> <span class="md-ellipsis"> execute_cypher_query </span> </a> </li> <li class="md-nav__item"> <a href="#add_package_to_graph" class="md-nav__link"> <span class="md-ellipsis"> add_package_to_graph </span> </a> </li> <li class="md-nav__item"> <a href="#find_dead_code" class="md-nav__link"> <span class="md-ellipsis"> find_dead_code </span> </a> </li> <li class="md-nav__item"> <a href="#calculate_cyclomatic_complexity" class="md-nav__link"> <span class="md-ellipsis"> calculate_cyclomatic_complexity </span> </a> </li> <li class="md-nav__item"> <a href="#find_most_complex_functions" class="md-nav__link"> <span class="md-ellipsis"> find_most_complex_functions </span> </a> </li> <li class="md-nav__item"> <a href="#list_indexed_repositories" class="md-nav__link"> <span class="md-ellipsis"> list_indexed_repositories </span> </a> </li> <li class="md-nav__item"> <a href="#delete_repository" class="md-nav__link"> <span class="md-ellipsis"> delete_repository </span> </a> </li> <li class="md-nav__item"> <a href="#visualize_graph_query" class="md-nav__link"> <span class="md-ellipsis"> visualize_graph_query </span> </a> </li> <li class="md-nav__item"> <a href="#list_watched_paths" class="md-nav__link"> <span class="md-ellipsis"> list_watched_paths </span> </a> </li> <li class="md-nav__item"> <a href="#unwatch_directory" class="md-nav__link"> <span class="md-ellipsis"> unwatch_directory </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item"> <a href="#other-methods" class="md-nav__link"> <span class="md-ellipsis"> Other Methods </span> </a> </li> </ul> </nav> </div> </div> </div> <div class="md-content" data-md-component="content"> <article class="md-content__inner md-typeset"> <h1 id="mcpserver">MCPServer</h1> <p>The <code>MCPServer</code> class is the core of the CodeGraphContext application. It orchestrates all the major components, including database management, background job tracking, file system watching, and tool handling.</p> <h2 id="initialization">Initialization</h2> <p>The server is initialized with an asyncio event loop. Upon initialization, it sets up the following components:</p> <ul> <li><code>DatabaseManager</code>: Manages the connection to the Neo4j database.</li> <li><code>JobManager</code>: Tracks the status of background jobs, such as code indexing.</li> <li><code>CodeWatcher</code>: Monitors the file system for changes to keep the code graph up-to-date.</li> <li><code>GraphBuilder</code>: Builds the code graph from the source code.</li> <li><code>CodeFinder</code>: Provides tools for searching and analyzing the code graph.</li> </ul> <h2 id="tool-manifest">Tool Manifest</h2> <p>The <code>MCPServer</code> exposes a set of tools to the AI assistant. These tools are defined in the <code>_init_tools</code> method. Here is a list of available tools:</p> <h3 id="add_code_to_graph"><code>add_code_to_graph</code></h3> <p>Performs a one-time scan of a local folder to add its code to the graph. Ideal for indexing libraries, dependencies, or projects not being actively modified. Returns a job ID for background processing.</p> <h3 id="check_job_status"><code>check_job_status</code></h3> <p>Check the status and progress of a background job.</p> <h3 id="list_jobs"><code>list_jobs</code></h3> <p>List all background jobs and their current status.</p> <h3 id="find_code"><code>find_code</code></h3> <p>Find relevant code snippets related to a keyword (e.g., function name, class name, or content).</p> <h3 id="analyze_code_relationships"><code>analyze_code_relationships</code></h3> <p>Analyze code relationships like 'who calls this function' or 'class hierarchy'. Supported query types include: find_callers, find_callees, find_all_callers, find_all_callees, find_importers, who_modifies, class_hierarchy, overrides, dead_code, call_chain, module_deps, variable_scope, find_complexity, find_functions_by_argument, find_functions_by_decorator.</p> <h3 id="watch_directory"><code>watch_directory</code></h3> <p>Performs an initial scan of a directory and then continuously monitors it for changes, automatically keeping the graph up-to-date. Ideal for projects under active development. Returns a job ID for the initial scan.</p> <h3 id="execute_cypher_query"><code>execute_cypher_query</code></h3> <p>This is an advanced tool for directly querying the underlying Neo4j graph using a read-only Cypher query. It should be used as a fallback when other tools cannot answer very specific or complex questions about the code graph.</p> <p><strong>Schema Overview:</strong></p> <p>The code graph has the following structure:</p> <ul> <li><strong>Nodes:</strong><ul> <li><code>Repository</code>: Represents a project repository.</li> <li><code>File</code>: Represents a single source code file.</li> <li><code>Module</code>: Represents a package or a module.</li> <li><code>Class</code>: Represents a class definition.</li> <li><code>Function</code>: Represents a function or method definition.</li> </ul> </li> <li><strong>Properties:</strong><ul> <li>Nodes have properties like <code>name</code>, <code>path</code>, <code>cyclomatic_complexity</code> (for functions), and <code>code</code>.</li> </ul> </li> <li><strong>Relationships:</strong><ul> <li><code>CONTAINS</code>: e.g., <code>(:File)-[:CONTAINS]-&gt;(:Function)</code></li> <li><code>CALLS</code>: e.g., <code>(:Function)-[:CALLS]-&gt;(:Function)</code></li> <li><code>IMPORTS</code>: e.g., <code>(:File)-[:IMPORTS]-&gt;(:Module)</code></li> <li><code>INHERITS</code>: e.g., <code>(:Class)-[:INHERITS]-&gt;(:Class)</code></li> </ul> </li> </ul> <h3 id="add_package_to_graph"><code>add_package_to_graph</code></h3> <p>Add a Python package to Neo4j graph by discovering its location. Returns immediately with job ID.</p> <h3 id="find_dead_code"><code>find_dead_code</code></h3> <p>Find potentially unused functions (dead code) across the entire indexed codebase, optionally excluding functions with specific decorators.</p> <h3 id="calculate_cyclomatic_complexity"><code>calculate_cyclomatic_complexity</code></h3> <p>Calculate the cyclomatic complexity of a specific function to measure its complexity.</p> <h3 id="find_most_complex_functions"><code>find_most_complex_functions</code></h3> <p>Find the most complex functions in the codebase based on cyclomatic complexity.</p> <h3 id="list_indexed_repositories"><code>list_indexed_repositories</code></h3> <p>List all indexed repositories.</p> <h3 id="delete_repository"><code>delete_repository</code></h3> <p>Delete an indexed repository from the graph.</p> <h3 id="visualize_graph_query"><code>visualize_graph_query</code></h3> <p>Generates a URL to visualize the results of a Cypher query in the Neo4j Browser. The user can open this URL in their web browser to see the graph visualization.</p> <h3 id="list_watched_paths"><code>list_watched_paths</code></h3> <p>Lists all directories currently being watched for live file changes.</p> <h3 id="unwatch_directory"><code>unwatch_directory</code></h3> <p>Stops watching a directory for live file changes.</p> <h2 id="other-methods">Other Methods</h2> <ul> <li><code>get_database_status()</code>: Returns the current connection status of the Neo4j database.</li> <li><code>get_local_package_path(package_name)</code>: Finds the local installation path of a Python package.</li> <li><code>run()</code>: Runs the main server loop, listening for JSON-RPC requests from stdin.</li> <li><code>shutdown()</code>: Gracefully shuts down the server and its components.</li> </ul> </article> </div> <script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script> </div> </main> <footer class="md-footer"> <div class="md-footer-meta md-typeset"> <div class="md-footer-meta__inner md-grid"> <div class="md-copyright"> Made with <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener"> Material for MkDocs </a> </div> </div> </div> </footer> </div> <div class="md-dialog" data-md-component="dialog"> <div class="md-dialog__inner md-typeset"></div> </div> <script id="__config" type="application/json">{"base": "..", "features": [], "search": "../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script> <script src="../assets/javascripts/bundle.f55a23d4.min.js"></script> </body> </html>

Latest Blog Posts

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/Shashankss1205/CodeGraphContext'

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