index.html•36.2 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="canonical" href="https://SaptaDey.github.io/Adaptive-Graph-of-Thoughts-MCP-server/getting_started/">
<link rel="prev" href="..">
<link rel="next" href="../configuration/">
<link rel="icon" href="../assets/images/favicon.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.14">
<title>Getting Started - Adaptive Graph of Thoughts Documentation</title>
<link rel="stylesheet" href="../assets/stylesheets/main.342714a4.min.css">
<link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.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>
<link rel="stylesheet" href="../assets/stylesheets/custom.css">
<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" data-md-color-scheme="default" data-md-color-primary="teal" data-md-color-accent="amber">
<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="#getting-started-with-adaptive-graph-of-thoughts" class="md-skip">
Skip to content
</a>
</div>
<div data-md-component="announce">
</div>
<header class="md-header" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
<a href=".." title="Adaptive Graph of Thoughts Documentation" class="md-header__button md-logo" aria-label="Adaptive Graph of Thoughts Documentation" 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">
Adaptive Graph of Thoughts Documentation
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
<span class="md-ellipsis">
Getting Started
</span>
</div>
</div>
</div>
<form class="md-header__option" data-md-component="palette">
<input class="md-option" data-md-color-media="" data-md-color-scheme="default" data-md-color-primary="teal" data-md-color-accent="amber" aria-label="Switch to dark mode" type="radio" name="__palette" id="__palette_0">
<label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_1" hidden>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a4 4 0 0 0-4 4 4 4 0 0 0 4 4 4 4 0 0 0 4-4 4 4 0 0 0-4-4m0 10a6 6 0 0 1-6-6 6 6 0 0 1 6-6 6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12z"/></svg>
</label>
<input class="md-option" data-md-color-media="" data-md-color-scheme="slate" data-md-color-primary="blue-grey" data-md-color-accent="orange" aria-label="Switch to light mode" type="radio" name="__palette" id="__palette_1">
<label class="md-header__button md-icon" title="Switch to light mode" for="__palette_0" hidden>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 18c-.89 0-1.74-.2-2.5-.55C11.56 16.5 13 14.42 13 12s-1.44-4.5-3.5-5.45C10.26 6.2 11.11 6 12 6a6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12z"/></svg>
</label>
</form>
<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>
<div class="md-search__suggest" data-md-component="search-suggest"></div>
</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>
<div class="md-header__source">
<a href="https://github.com/SaptaDey/Adaptive-Graph-of-Thoughts-MCP-server" title="Go to repository" class="md-source" data-md-component="source">
<div class="md-source__icon md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.7.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81"/></svg>
</div>
<div class="md-source__repository">
Adaptive-Graph-of-Thoughts-MCP-server
</div>
</a>
</div>
</nav>
</header>
<div class="md-container" data-md-component="container">
<nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
<div class="md-grid">
<ul class="md-tabs__list">
<li class="md-tabs__item">
<a href=".." class="md-tabs__link">
Home
</a>
</li>
<li class="md-tabs__item md-tabs__item--active">
<a href="./" class="md-tabs__link">
Getting Started
</a>
</li>
<li class="md-tabs__item">
<a href="../configuration/" class="md-tabs__link">
Configuration
</a>
</li>
<li class="md-tabs__item">
<a href="../usage/" class="md-tabs__link">
Usage
</a>
</li>
<li class="md-tabs__item">
<a href="../vscode_extension/" class="md-tabs__link">
VS Code Extension
</a>
</li>
<li class="md-tabs__item">
<a href="../claude_action/" class="md-tabs__link">
Claude Desktop Action
</a>
</li>
<li class="md-tabs__item">
<a href="../api/mcp_api/" class="md-tabs__link">
API Reference
</a>
</li>
<li class="md-tabs__item">
<a href="../extending/custom_stages/" class="md-tabs__link">
Extending Adaptive Graph of Thoughts
</a>
</li>
<li class="md-tabs__item">
<a href="../CONTRIBUTING/" class="md-tabs__link">
Contributing
</a>
</li>
<li class="md-tabs__item">
<a href="../ROADMAP/" class="md-tabs__link">
Roadmap
</a>
</li>
</ul>
</div>
</nav>
<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 md-nav--lifted md-nav--integrated" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
<a href=".." title="Adaptive Graph of Thoughts Documentation" class="md-nav__button md-logo" aria-label="Adaptive Graph of Thoughts Documentation" 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>
Adaptive Graph of Thoughts Documentation
</label>
<div class="md-nav__source">
<a href="https://github.com/SaptaDey/Adaptive-Graph-of-Thoughts-MCP-server" title="Go to repository" class="md-source" data-md-component="source">
<div class="md-source__icon md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.7.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81"/></svg>
</div>
<div class="md-source__repository">
Adaptive-Graph-of-Thoughts-MCP-server
</div>
</a>
</div>
<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 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">
Getting Started
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
<span class="md-ellipsis">
Getting Started
</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="#core-prerequisites" class="md-nav__link">
<span class="md-ellipsis">
Core Prerequisites
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#installation-and-setup-local-development" class="md-nav__link">
<span class="md-ellipsis">
Installation and Setup (Local Development)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#docker-deployment" class="md-nav__link">
<span class="md-ellipsis">
Docker Deployment
</span>
</a>
<nav class="md-nav" aria-label="Docker Deployment">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#1-quick-start-with-docker-compose-recommended-for-development" class="md-nav__link">
<span class="md-ellipsis">
1. Quick Start with Docker Compose (Recommended for Development)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#2-individual-docker-container-manual-run" class="md-nav__link">
<span class="md-ellipsis">
2. Individual Docker Container (Manual Run)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#3-production-deployment" class="md-nav__link">
<span class="md-ellipsis">
3. Production Deployment
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#notes-on-specific-deployment-platforms" class="md-nav__link">
<span class="md-ellipsis">
Notes on Specific Deployment Platforms
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#accessing-the-services-after-deployment" class="md-nav__link">
<span class="md-ellipsis">
Accessing the Services (after deployment)
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="../configuration/" class="md-nav__link">
<span class="md-ellipsis">
Configuration
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../usage/" class="md-nav__link">
<span class="md-ellipsis">
Usage
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../vscode_extension/" class="md-nav__link">
<span class="md-ellipsis">
VS Code Extension
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../claude_action/" class="md-nav__link">
<span class="md-ellipsis">
Claude Desktop Action
</span>
</a>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_7" >
<label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="0">
<span class="md-ellipsis">
API Reference
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_7">
<span class="md-nav__icon md-icon"></span>
API Reference
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../api/mcp_api/" class="md-nav__link">
<span class="md-ellipsis">
MCP API
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_8" >
<label class="md-nav__link" for="__nav_8" id="__nav_8_label" tabindex="0">
<span class="md-ellipsis">
Extending Adaptive Graph of Thoughts
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_8_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_8">
<span class="md-nav__icon md-icon"></span>
Extending Adaptive Graph of Thoughts
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../extending/custom_stages/" class="md-nav__link">
<span class="md-ellipsis">
Custom Stages
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../extending_with_claude/" class="md-nav__link">
<span class="md-ellipsis">
Claude API Integration
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="../CONTRIBUTING/" class="md-nav__link">
<span class="md-ellipsis">
Contributing
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../ROADMAP/" class="md-nav__link">
<span class="md-ellipsis">
Roadmap
</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="getting-started-with-adaptive-graph-of-thoughts">Getting Started with Adaptive Graph of Thoughts</h1>
<p>This guide will help you get Adaptive Graph of Thoughts up and running, whether for local development or Docker-based deployment.</p>
<div class="admonition important">
<p class="admonition-title">Deployment Prerequisites</p>
<p>Before running Adaptive Graph of Thoughts (either locally or via Docker if not using the provided <code>docker-compose.prod.yml</code> which includes Neo4j), ensure you have:</p>
</div>
<ul>
<li>
<p><strong>A running Neo4j Instance</strong>: Adaptive Graph of Thoughts requires a connection to a Neo4j graph database.</p>
<ul>
<li><strong>APOC Library</strong>: The Neo4j instance <strong>must</strong> have the APOC (Awesome Procedures On Cypher) library installed. Many Cypher queries rely on APOC procedures. See the <a href="https://neo4j.com/labs/apoc/installation/">official APOC website</a> for installation.</li>
<li><strong>Indexing</strong>: For optimal performance, ensure appropriate Neo4j indexes are created. See <a href="../neo4j_indexing/">Neo4j Indexing Strategy</a> for details. <!-- TODO: Ensure this link works after file moves --></li>
</ul>
<p><em>Note: The provided <code>docker-compose.yml</code> (for development) and <code>docker-compose.prod.yml</code> (for production) already include a Neo4j service with the APOC library pre-configured, satisfying this requirement when using Docker Compose.</em></p>
</li>
</ul>
<h2 id="core-prerequisites">Core Prerequisites</h2>
<ul>
<li><strong>Python 3.11+</strong> (as specified in <code>pyproject.toml</code>)</li>
<li><strong><a href="https://python-poetry.org/docs/#installation">Poetry</a></strong>: For dependency management.</li>
<li><strong><a href="https://www.docker.com/get-started">Docker</a></strong> and <strong><a href="https://docs.docker.com/compose/install/">Docker Compose</a></strong>: For containerized deployment.</li>
</ul>
<h2 id="installation-and-setup-local-development">Installation and Setup (Local Development)</h2>
<ol>
<li>
<p><strong>Clone the repository</strong>:
<div class="highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a>git<span class="w"> </span>clone<span class="w"> </span>https://github.com/SaptaDey/Adaptive-Graph-of-Thoughts-MCP.git<span class="w"> </span><span class="c1"># Adjust if your fork/repo is different</span>
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a><span class="nb">cd</span><span class="w"> </span>Adaptive-Graph-of-Thoughts-MCP
</code></pre></div></p>
</li>
<li>
<p><strong>Install dependencies using Poetry</strong>:
<div class="highlight"><pre><span></span><code><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a>poetry<span class="w"> </span>install<span class="w"> </span>--with<span class="w"> </span>dev<span class="w"> </span><span class="c1"># Installs main and development dependencies</span>
</code></pre></div>
This creates a virtual environment (if one isn't already activated) and installs all necessary packages.</p>
</li>
<li>
<p><strong>Activate the virtual environment</strong>:
<div class="highlight"><pre><span></span><code><a id="__codelineno-2-1" name="__codelineno-2-1" href="#__codelineno-2-1"></a>poetry<span class="w"> </span>shell
</code></pre></div></p>
</li>
</ol>
<div class="admonition danger">
<p class="admonition-title">Configure Neo4j Connection (Critical)</p>
<p>Adaptive Graph of Thoughts connects to Neo4j using environment variables. See the <a href="../configuration/#neo4j-database-configuration">Configuration Guide</a> for detailed instructions on setting <code>NEO4J_URI</code>, <code>NEO4J_USER</code>, <code>NEO4J_PASSWORD</code>, and <code>NEO4J_DATABASE</code>. For local development, using a <code>.env</code> file is recommended.</p>
</div>
<ol>
<li>
<p><strong>Application Configuration</strong>:
Other application settings are in <code>config/settings.yaml</code>. You can review and customize this file if needed. See the <a href="../configuration/#application-settings">Configuration Guide</a> for more details.</p>
</li>
<li>
<p><strong>Run the development server</strong>:
Ensure your Neo4j instance is running and accessible with the configured credentials.</p>
<p>If you haven't set <code>NEO4J_PASSWORD</code> in a <code>.env</code> file, you might need to provide it directly (though <code>.env</code> is preferred):
<div class="highlight"><pre><span></span><code><a id="__codelineno-3-1" name="__codelineno-3-1" href="#__codelineno-3-1"></a><span class="nv">NEO4J_PASSWORD</span><span class="o">=</span><span class="s2">"your_neo4j_password"</span><span class="w"> </span>poetry<span class="w"> </span>run<span class="w"> </span>uvicorn<span class="w"> </span>src.adaptive_graph_of_thoughts.main:app<span class="w"> </span>--reload<span class="w"> </span>--host<span class="w"> </span><span class="m">0</span>.0.0.0<span class="w"> </span>--port<span class="w"> </span><span class="m">8000</span>
</code></pre></div>
If using a <code>.env</code> file (recommended for all Neo4j credentials):
<div class="highlight"><pre><span></span><code><a id="__codelineno-4-1" name="__codelineno-4-1" href="#__codelineno-4-1"></a>poetry<span class="w"> </span>run<span class="w"> </span>uvicorn<span class="w"> </span>src.adaptive_graph_of_thoughts.main:app<span class="w"> </span>--reload<span class="w"> </span>--host<span class="w"> </span><span class="m">0</span>.0.0.0<span class="w"> </span>--port<span class="w"> </span><span class="m">8000</span>
</code></pre></div>
The API will be available at <code>http://localhost:8000</code> (or the port you configured, e.g., via <code>APP_PORT</code> in your <code>.env</code> file).</p>
</li>
</ol>
<h2 id="docker-deployment">Docker Deployment</h2>
<p>Adaptive Graph of Thoughts is designed to be easily deployed using Docker.</p>
<!-- Mermaid diagram for Docker deployment can be included here if desired -->
<!-- ```mermaid
graph TB
subgraph "Development Environment"
A[👨💻 Developer] -->
<p>B[🐳 Docker Compose]
end</p>
<div class="highlight"><pre><span></span><code>subgraph "Container Orchestration"
B --> C[📦 Adaptive Graph of Thoughts Container]
B --> D[📊 Monitoring Container] # Placeholder if you add monitoring
B --> E[🗄️ Database Container]
end
subgraph "Adaptive Graph of Thoughts Application"
C --> F[⚡ FastAPI Server]
F --> G[🧠 ASR-GoT Engine]
F --> H[🔌 MCP Protocol]
end
subgraph "External Integrations"
H --> I[🤖 Claude Desktop]
H --> J[🔗 Other AI Clients]
end
</code></pre></div>
<p>``` --></p>
<h3 id="1-quick-start-with-docker-compose-recommended-for-development">1. Quick Start with Docker Compose (Recommended for Development)</h3>
<p>The <code>docker-compose.yml</code> file is pre-configured for local development and includes the Adaptive Graph of Thoughts API service and a Neo4j service with APOC.</p>
<p><div class="highlight"><pre><span></span><code><a id="__codelineno-5-1" name="__codelineno-5-1" href="#__codelineno-5-1"></a><span class="c1"># Build and run all services</span>
<a id="__codelineno-5-2" name="__codelineno-5-2" href="#__codelineno-5-2"></a>docker-compose<span class="w"> </span>up<span class="w"> </span>--build
<a id="__codelineno-5-3" name="__codelineno-5-3" href="#__codelineno-5-3"></a>
<a id="__codelineno-5-4" name="__codelineno-5-4" href="#__codelineno-5-4"></a><span class="c1"># For detached mode (background)</span>
<a id="__codelineno-5-5" name="__codelineno-5-5" href="#__codelineno-5-5"></a>docker-compose<span class="w"> </span>up<span class="w"> </span>--build<span class="w"> </span>-d
<a id="__codelineno-5-6" name="__codelineno-5-6" href="#__codelineno-5-6"></a>
<a id="__codelineno-5-7" name="__codelineno-5-7" href="#__codelineno-5-7"></a><span class="c1"># View logs for the API service</span>
<a id="__codelineno-5-8" name="__codelineno-5-8" href="#__codelineno-5-8"></a>docker-compose<span class="w"> </span>logs<span class="w"> </span>-f<span class="w"> </span>adaptive-graph-of-thoughts-api
</code></pre></div>
Ensure you have a <code>.env</code> file with your <code>NEO4J_PASSWORD</code> (and other Neo4j settings if not using defaults) as <code>docker-compose.yml</code> is set up to use it.</p>
<h3 id="2-individual-docker-container-manual-run">2. Individual Docker Container (Manual Run)</h3>
<p><div class="highlight"><pre><span></span><code><a id="__codelineno-6-1" name="__codelineno-6-1" href="#__codelineno-6-1"></a><span class="c1"># Build the image</span>
<a id="__codelineno-6-2" name="__codelineno-6-2" href="#__codelineno-6-2"></a>docker<span class="w"> </span>build<span class="w"> </span>-t<span class="w"> </span>adaptive-graph-of-thoughts:latest<span class="w"> </span>.
<a id="__codelineno-6-3" name="__codelineno-6-3" href="#__codelineno-6-3"></a>
<a id="__codelineno-6-4" name="__codelineno-6-4" href="#__codelineno-6-4"></a><span class="c1"># Run the container (ensure NEO4J_* env vars are set, e.g., via --env-file)</span>
<a id="__codelineno-6-5" name="__codelineno-6-5" href="#__codelineno-6-5"></a>docker<span class="w"> </span>run<span class="w"> </span>-d<span class="w"> </span><span class="se">\</span>
<a id="__codelineno-6-6" name="__codelineno-6-6" href="#__codelineno-6-6"></a><span class="w"> </span>-p<span class="w"> </span><span class="m">8000</span>:8000<span class="w"> </span><span class="se">\</span>
<a id="__codelineno-6-7" name="__codelineno-6-7" href="#__codelineno-6-7"></a><span class="w"> </span>--env-file<span class="w"> </span>.env<span class="w"> </span><span class="se">\</span>
<a id="__codelineno-6-8" name="__codelineno-6-8" href="#__codelineno-6-8"></a><span class="w"> </span>-v<span class="w"> </span>/path/to/your/local/config:/app/config<span class="w"> </span><span class="se">\</span>
<a id="__codelineno-6-9" name="__codelineno-6-9" href="#__codelineno-6-9"></a><span class="w"> </span>adaptive-graph-of-thoughts:latest
</code></pre></div>
Replace <code>/path/to/your/local/config</code> with the actual path to your <em>custom</em> configuration directory if you need to override the defaults baked into the image. See the <a href="../configuration/#docker-configuration-override">Configuration Guide</a> for more details.</p>
<h3 id="3-production-deployment">3. Production Deployment</h3>
<p>For production, use the <code>docker-compose.prod.yml</code> file:
<div class="highlight"><pre><span></span><code><a id="__codelineno-7-1" name="__codelineno-7-1" href="#__codelineno-7-1"></a><span class="c1"># Ensure all required environment variables (especially NEO4J_PASSWORD) are set</span>
<a id="__codelineno-7-2" name="__codelineno-7-2" href="#__codelineno-7-2"></a><span class="c1"># in your production environment or a secure .env file used by the compose file.</span>
<a id="__codelineno-7-3" name="__codelineno-7-3" href="#__codelineno-7-3"></a>docker-compose<span class="w"> </span>-f<span class="w"> </span>docker-compose.prod.yml<span class="w"> </span>up<span class="w"> </span>--build<span class="w"> </span>-d
</code></pre></div>
Refer to the <a href="../configuration/#production-environment-variables">Production Configuration section in the Configuration Guide</a> for details on required environment variables.</p>
<h3 id="notes-on-specific-deployment-platforms">Notes on Specific Deployment Platforms</h3>
<ul>
<li><strong>Smithery.ai</strong>: Deploy using the provided <code>smithery.yaml</code>.<ul>
<li>Connect your repository on Smithery and click <strong>Deploy</strong>.</li>
<li>The container listens on the <code>PORT</code> environment variable (default <code>8000</code>).</li>
<li><strong>Health Checks</strong> use the <code>/health</code> endpoint.</li>
<li>Configure required environment variables (e.g. <code>NEO4J_PASSWORD</code>) through the Smithery dashboard.</li>
</ul>
</li>
</ul>
<h3 id="accessing-the-services-after-deployment">Accessing the Services (after deployment)</h3>
<ul>
<li><strong>API Documentation (Swagger UI)</strong>: <code>http://localhost:8000/docs</code></li>
<li><strong>Health Check</strong>: <code>http://localhost:8000/health</code></li>
<li><strong>MCP Endpoint</strong>: <code>http://localhost:8000/mcp</code> (or the relevant service address if deployed)</li>
</ul>
<p>Navigate to these URLs in your browser or API client after starting the application.</p>
</article>
</div>
<script>var tabs=__md_get("__tabs");if(Array.isArray(tabs))e:for(var set of document.querySelectorAll(".tabbed-set")){var labels=set.querySelector(".tabbed-labels");for(var tab of tabs)for(var label of labels.getElementsByTagName("label"))if(label.innerText.trim()===tab){var input=document.getElementById(label.htmlFor);input.checked=!0;continue e}}</script>
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
</div>
<button type="button" class="md-top md-icon" data-md-component="top" hidden>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8z"/></svg>
Back to top
</button>
</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": ["navigation.tabs", "navigation.sections", "toc.integrate", "navigation.top", "search.suggest", "search.highlight", "content.tabs.link", "content.code.annotation", "content.code.copy", "navigation.indexes", "navigation.expand", "header.autohide"], "search": "../assets/javascripts/workers/search.d50fe291.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.13a4f30d.min.js"></script>
<script src="https://unpkg.com/mermaid@10.4.0/dist/mermaid.min.js"></script>
</body>
</html>