mcp-server-webcrawl

mcp_server_webcrawl.interactive.html•128 kB

<!DOCTYPE html> <html class="writer-html5" lang="en" data-content_root="./"> <head> <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" /> <title>mcp_server_webcrawl.interactive package — mcp-server-webcrawl documentation</title> <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" /> <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" /> <script src="_static/jquery.js?v=5d32c60e"></script> <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script> <script src="_static/documentation_options.js?v=5929fcd5"></script> <script src="_static/doctools.js?v=888ff710"></script> <script src="_static/sphinx_highlight.js?v=dc90522c"></script> <script src="_static/js/theme.js"></script> <link rel="index" title="Index" href="genindex.html" /> <link rel="search" title="Search" href="search.html" /> <link rel="next" title="mcp_server_webcrawl.models package" href="mcp_server_webcrawl.models.html" /> <link rel="prev" title="mcp_server_webcrawl.extras package" href="mcp_server_webcrawl.extras.html" /> </head> <body class="wy-body-for-nav"> <div class="wy-grid-for-nav"> <nav data-toggle="wy-nav-shift" class="wy-nav-side"> <div class="wy-side-scroll"> <div class="wy-side-nav-search" > <a href="index.html" class="icon icon-home"> mcp-server-webcrawl </a> <div role="search"> <form id="rtd-search-form" class="wy-form" action="search.html" method="get"> <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" /> <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> </div> </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu"> Contents: <ul class="current"> <li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li> <li class="toctree-l1"><a class="reference internal" href="guides.html">Setup Guides</a></li> <li class="toctree-l1"><a class="reference internal" href="usage.html">Usage</a></li> <li class="toctree-l1"><a class="reference internal" href="prompts.html">Prompt Routines</a></li> <li class="toctree-l1"><a class="reference internal" href="interactive.html">Interactive Mode</a></li> <li class="toctree-l1 current"><a class="reference internal" href="modules.html">mcp_server_webcrawl</a><ul class="current"> <li class="toctree-l2 current"><a class="reference internal" href="mcp_server_webcrawl.html">mcp_server_webcrawl package</a></li> </ul> </li> </ul> </div> </div> </nav> <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" > <a href="index.html">mcp-server-webcrawl</a> </nav> <div class="wy-nav-content"> <div class="rst-content"> <div role="navigation" aria-label="Page navigation"> <ul class="wy-breadcrumbs"> <li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li> <li class="breadcrumb-item"><a href="modules.html">mcp_server_webcrawl</a></li> <li class="breadcrumb-item"><a href="mcp_server_webcrawl.html">mcp_server_webcrawl package</a></li> <li class="breadcrumb-item active">mcp_server_webcrawl.interactive package</li> <li class="wy-breadcrumbs-aside"> <a href="_sources/mcp_server_webcrawl.interactive.rst.txt" rel="nofollow"> View page source</a> </li> </ul> <hr/> </div> <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> <div itemprop="articleBody"> <section id="mcp-server-webcrawl-interactive-package"> <h1>mcp_server_webcrawl.interactive package<a class="headerlink" href="#mcp-server-webcrawl-interactive-package" title="Link to this heading"></a></h1> <section id="submodules"> <h2>Submodules<a class="headerlink" href="#submodules" title="Link to this heading"></a></h2> </section> <section id="module-mcp_server_webcrawl.interactive.highlights"> <h2>mcp_server_webcrawl.interactive.highlights module<a class="headerlink" href="#module-mcp_server_webcrawl.interactive.highlights" title="Link to this heading"></a></h2> <dl class="py class"> <dt class="sig sig-object py" id="mcp_server_webcrawl.interactive.highlights.HighlightSpan"> class HighlightSpan<a class="reference internal" href="_modules/mcp_server_webcrawl/interactive/highlights.html#HighlightSpan">[source]</a><a class="headerlink" href="#mcp_server_webcrawl.interactive.highlights.HighlightSpan" title="Link to this definition"></a></dt> <dd>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate">object</code></a> Represents a highlight span in text <dl class="py attribute"> <dt class="sig sig-object py" id="mcp_server_webcrawl.interactive.highlights.HighlightSpan.start"> start: <a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)">int</a><a class="headerlink" href="#mcp_server_webcrawl.interactive.highlights.HighlightSpan.start" title="Link to this definition"></a></dt> <dd></dd></dl> <dl class="py attribute"> <dt class="sig sig-object py" id="mcp_server_webcrawl.interactive.highlights.HighlightSpan.end"> end: <a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)">int</a><a class="headerlink" href="#mcp_server_webcrawl.interactive.highlights.HighlightSpan.end" title="Link to this definition"></a></dt> <dd></dd></dl> <dl class="py attribute"> <dt class="sig sig-object py" id="mcp_server_webcrawl.interactive.highlights.HighlightSpan.text"> text: <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)">str</a><a class="headerlink" href="#mcp_server_webcrawl.interactive.highlights.HighlightSpan.text" title="Link to this definition"></a></dt> <dd></dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="mcp_server_webcrawl.interactive.highlights.HighlightSpan.__init__"> __init__(start, end, text)<a class="headerlink" href="#mcp_server_webcrawl.interactive.highlights.HighlightSpan.__init__" title="Link to this definition"></a></dt> <dd><dl class="field-list simple"> <dt class="field-odd">Parameters:</dt> <dd class="field-odd"><ul class="simple"> <li>start (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)">int</a>) – </li> <li>end (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)">int</a>) – </li> <li>text (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)">str</a>) – </li> </ul> </dd> <dt class="field-even">Return type:</dt> <dd class="field-even">None </dd> </dl> </dd></dl> </dd></dl> <dl class="py class"> <dt class="sig sig-object py" id="mcp_server_webcrawl.interactive.highlights.HighlightProcessor"> class HighlightProcessor<a class="reference internal" href="_modules/mcp_server_webcrawl/interactive/highlights.html#HighlightProcessor">[source]</a><a class="headerlink" href="#mcp_server_webcrawl.interactive.highlights.HighlightProcessor" title="Link to this definition"></a></dt> <dd>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate">object</code></a> Shared highlight processing utilities <dl class="py attribute"> <dt class="sig sig-object py" id="mcp_server_webcrawl.interactive.highlights.HighlightProcessor.QUOTED_PHRASE_PATTERN"> QUOTED_PHRASE_PATTERN = re.compile('"([^"]+)"')<a class="headerlink" href="#mcp_server_webcrawl.interactive.highlights.HighlightProcessor.QUOTED_PHRASE_PATTERN" title="Link to this definition"></a></dt> <dd></dd></dl> <dl class="py attribute"> <dt class="sig sig-object py" id="mcp_server_webcrawl.interactive.highlights.HighlightProcessor.WORD_PATTERN"> WORD_PATTERN = re.compile('\\b\\w+\\b')<a class="headerlink" href="#mcp_server_webcrawl.interactive.highlights.HighlightProcessor.WORD_PATTERN" title="Link to this definition"></a></dt> <dd></dd></dl> <dl class="py attribute"> <dt class="sig sig-object py" id="mcp_server_webcrawl.interactive.highlights.HighlightProcessor.SNIPPET_MARKER_PATTERN"> SNIPPET_MARKER_PATTERN = re.compile("\\*\\*([a-zA-Z\\-_' ]+)\\*\\*")<a class="headerlink" href="#mcp_server_webcrawl.interactive.highlights.HighlightProcessor.SNIPPET_MARKER_PATTERN" title="Link to this definition"></a></dt> <dd></dd></dl> <dl class="py attribute"> <dt class="sig sig-object py" id="mcp_server_webcrawl.interactive.highlights.HighlightProcessor.IGNORE_WORDS"> IGNORE_WORDS = {'AND', 'NOT', 'OR', 'and', 'id', 'not', 'or', 'size', 'status', 'type', 'url'}<a class="headerlink" href="#mcp_server_webcrawl.interactive.highlights.HighlightProcessor.IGNORE_WORDS" title="Link to this definition"></a></dt> <dd></dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="mcp_server_webcrawl.interactive.highlights.HighlightProcessor.extract_search_terms"> static extract_search_terms(query)<a class="reference internal" href="_modules/mcp_server_webcrawl/interactive/highlights.html#HighlightProcessor.extract_search_terms">[source]</a><a class="headerlink" href="#mcp_server_webcrawl.interactive.highlights.HighlightProcessor.extract_search_terms" title="Link to this definition"></a></dt> <dd>Extract search terms from query, handling quoted phrases and individual keywords. <dl class="field-list simple"> <dt class="field-odd">Parameters:</dt> <dd class="field-odd">query (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)">str</a>) – </dd> <dt class="field-even">Return type:</dt> <dd class="field-even"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.List" title="(in Python v3.13)">List</a>[<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)">str</a>] </dd> </dl> </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="mcp_server_webcrawl.interactive.highlights.HighlightProcessor.find_highlights_in_text"> static find_highlights_in_text(text, search_terms)<a class="reference internal" href="_modules/mcp_server_webcrawl/interactive/highlights.html#HighlightProcessor.find_highlights_in_text">[source]</a><a class="headerlink" href="#mcp_server_webcrawl.interactive.highlights.HighlightProcessor.find_highlights_in_text" title="Link to this definition"></a></dt> <dd>Find all highlight spans in text for the given search terms. <dl class="field-list simple"> <dt class="field-odd">Parameters:</dt> <dd class="field-odd"><ul class="simple"> <li>text (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)">str</a>) – </li> <li>search_terms (<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.List" title="(in Python v3.13)">List</a>[<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)">str</a>]) – </li> </ul> </dd> <dt class="field-even">Return type:</dt> <dd class="field-even"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.List" title="(in Python v3.13)">List</a>[<a class="reference internal" href="#mcp_server_webcrawl.interactive.highlights.HighlightSpan" title="mcp_server_webcrawl.interactive.highlights.HighlightSpan">HighlightSpan</a>] </dd> </dl> </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="mcp_server_webcrawl.interactive.highlights.HighlightProcessor.extract_snippet_highlights"> static extract_snippet_highlights(snippet_text)<a class="reference internal" href="_modules/mcp_server_webcrawl/interactive/highlights.html#HighlightProcessor.extract_snippet_highlights">[source]</a><a class="headerlink" href="#mcp_server_webcrawl.interactive.highlights.HighlightProcessor.extract_snippet_highlights" title="Link to this definition"></a></dt> <dd>Extract highlights from snippet text with markers, returning clean text and highlights. <dl class="field-list simple"> <dt class="field-odd">Parameters:</dt> <dd class="field-odd">snippet_text (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)">str</a>) – </dd> <dt class="field-even">Return type:</dt> <dd class="field-even"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.13)">tuple</a>[<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)">str</a>, <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.List" title="(in Python v3.13)">List</a>[<a class="reference internal" href="#mcp_server_webcrawl.interactive.highlights.HighlightSpan" title="mcp_server_webcrawl.interactive.highlights.HighlightSpan">HighlightSpan</a>]] </dd> </dl> </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="mcp_server_webcrawl.interactive.highlights.HighlightProcessor.merge_overlapping_highlights"> static merge_overlapping_highlights(highlights, text)<a class="reference internal" href="_modules/mcp_server_webcrawl/interactive/highlights.html#HighlightProcessor.merge_overlapping_highlights">[source]</a><a class="headerlink" href="#mcp_server_webcrawl.interactive.highlights.HighlightProcessor.merge_overlapping_highlights" title="Link to this definition"></a></dt> <dd>Merge overlapping or adjacent highlight spans. <dl class="field-list simple"> <dt class="field-odd">Parameters:</dt> <dd class="field-odd"><ul class="simple"> <li>highlights (<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.List" title="(in Python v3.13)">List</a>[<a class="reference internal" href="#mcp_server_webcrawl.interactive.highlights.HighlightSpan" title="mcp_server_webcrawl.interactive.highlights.HighlightSpan">HighlightSpan</a>]) – </li> <li>text (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)">str</a>) – </li> </ul> </dd> <dt class="field-even">Return type:</dt> <dd class="field-even"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.List" title="(in Python v3.13)">List</a>[<a class="reference internal" href="#mcp_server_webcrawl.interactive.highlights.HighlightSpan" title="mcp_server_webcrawl.interactive.highlights.HighlightSpan">HighlightSpan</a>] </dd> </dl> </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="mcp_server_webcrawl.interactive.highlights.HighlightProcessor.render_text_with_highlights"> static render_text_with_highlights(stdscr, text, highlights, x, y, max_width, normal_style, hit_style)<a class="reference internal" href="_modules/mcp_server_webcrawl/interactive/highlights.html#HighlightProcessor.render_text_with_highlights">[source]</a><a class="headerlink" href="#mcp_server_webcrawl.interactive.highlights.HighlightProcessor.render_text_with_highlights" title="Link to this definition"></a></dt> <dd>Render text with highlights applied. <dl class="field-list simple"> <dt class="field-odd">Parameters:</dt> <dd class="field-odd"><ul class="simple"> <li>stdscr (window) – </li> <li>text (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)">str</a>) – </li> <li>highlights (<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.List" title="(in Python v3.13)">List</a>[<a class="reference internal" href="#mcp_server_webcrawl.interactive.highlights.HighlightSpan" title="mcp_server_webcrawl.interactive.highlights.HighlightSpan">HighlightSpan</a>]) – </li> <li>x (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)">int</a>) – </li> <li>y (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)">int</a>) – </li> <li>max_width (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)">int</a>) – </li> <li>normal_style (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)">int</a>) – </li> <li>hit_style (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)">int</a>) – </li> </ul> </dd> <dt class="field-even">Return type:</dt> <dd class="field-even">None </dd> </dl> </dd></dl> </dd></dl> </section> <section id="module-mcp_server_webcrawl.interactive.search"> <h2>mcp_server_webcrawl.interactive.search module<a class="headerlink" href="#module-mcp_server_webcrawl.interactive.search" title="Link to this heading"></a></h2> <dl class="py class"> <dt class="sig sig-object py" id="mcp_server_webcrawl.interactive.search.SearchManager"> class SearchManager<a class="reference internal" href="_modules/mcp_server_webcrawl/interactive/search.html#SearchManager">[source]</a><a class="headerlink" href="#mcp_server_webcrawl.interactive.search.SearchManager" title="Link to this definition"></a></dt> <dd>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate">object</code></a> Manages search operations including async search and debouncing. Works with session’s controlled interface - never touches private state directly. <dl class="py method"> <dt class="sig sig-object py" id="mcp_server_webcrawl.interactive.search.SearchManager.__init__"> __init__(session)<a class="reference internal" href="_modules/mcp_server_webcrawl/interactive/search.html#SearchManager.__init__">[source]</a><a class="headerlink" href="#mcp_server_webcrawl.interactive.search.SearchManager.__init__" title="Link to this definition"></a></dt> <dd><dl class="field-list simple"> <dt class="field-odd">Parameters:</dt> <dd class="field-odd">session (<a class="reference internal" href="#mcp_server_webcrawl.interactive.session.InteractiveSession" title="mcp_server_webcrawl.interactive.session.InteractiveSession">InteractiveSession</a>) – </dd> </dl> </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="mcp_server_webcrawl.interactive.search.SearchManager.autosearch"> autosearch(immediate=False)<a class="reference internal" href="_modules/mcp_server_webcrawl/interactive/search.html#SearchManager.autosearch">[source]</a><a class="headerlink" href="#mcp_server_webcrawl.interactive.search.SearchManager.autosearch" title="Link to this definition"></a></dt> <dd>Trigger search with optional immediate execution. <dl class="field-list simple"> <dt class="field-odd">Parameters:</dt> <dd class="field-odd">immediate (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.13)">bool</a>) – If True, execute search synchronously without debouncing. If False, use debounced async execution (default). </dd> <dt class="field-even">Return type:</dt> <dd class="field-even">None </dd> </dl> </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="mcp_server_webcrawl.interactive.search.SearchManager.cancel_pending"> cancel_pending()<a class="reference internal" href="_modules/mcp_server_webcrawl/interactive/search.html#SearchManager.cancel_pending">[source]</a><a class="headerlink" href="#mcp_server_webcrawl.interactive.search.SearchManager.cancel_pending" title="Link to this definition"></a></dt> <dd>Cancel any pending search timer. <dl class="field-list simple"> <dt class="field-odd">Return type:</dt> <dd class="field-odd">None </dd> </dl> </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="mcp_server_webcrawl.interactive.search.SearchManager.check_pending"> check_pending()<a class="reference internal" href="_modules/mcp_server_webcrawl/interactive/search.html#SearchManager.check_pending">[source]</a><a class="headerlink" href="#mcp_server_webcrawl.interactive.search.SearchManager.check_pending" title="Link to this definition"></a></dt> <dd>Check if there are pending search results and update the UI. <dl class="field-list simple"> <dt class="field-odd">Return type:</dt> <dd class="field-odd">None </dd> </dl> </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="mcp_server_webcrawl.interactive.search.SearchManager.cleanup"> cleanup()<a class="reference internal" href="_modules/mcp_server_webcrawl/interactive/search.html#SearchManager.cleanup">[source]</a><a class="headerlink" href="#mcp_server_webcrawl.interactive.search.SearchManager.cleanup" title="Link to this definition"></a></dt> <dd>Clean up any pending operations. <dl class="field-list simple"> <dt class="field-odd">Return type:</dt> <dd class="field-odd">None </dd> </dl> </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="mcp_server_webcrawl.interactive.search.SearchManager.has_pending"> has_pending()<a class="reference internal" href="_modules/mcp_server_webcrawl/interactive/search.html#SearchManager.has_pending">[source]</a><a class="headerlink" href="#mcp_server_webcrawl.interactive.search.SearchManager.has_pending" title="Link to this definition"></a></dt> <dd>Check if there’s a pending debounced search. <dl class="field-list simple"> <dt class="field-odd">Return type:</dt> <dd class="field-odd"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.13)">bool</a> </dd> </dl> </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="mcp_server_webcrawl.interactive.search.SearchManager.is_searching"> is_searching()<a class="reference internal" href="_modules/mcp_server_webcrawl/interactive/search.html#SearchManager.is_searching">[source]</a><a class="headerlink" href="#mcp_server_webcrawl.interactive.search.SearchManager.is_searching" title="Link to this definition"></a></dt> <dd>Check if a search is currently in progress or on a timer. <dl class="field-list simple"> <dt class="field-odd">Return type:</dt> <dd class="field-odd"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.13)">bool</a> </dd> </dl> </dd></dl> </dd></dl> </section> <section id="module-mcp_server_webcrawl.interactive.session"> <h2>mcp_server_webcrawl.interactive.session module<a class="headerlink" href="#module-mcp_server_webcrawl.interactive.session" title="Link to this heading"></a></h2> <dl class="py class"> <dt class="sig sig-object py" id="mcp_server_webcrawl.interactive.session.InteractiveSession"> class InteractiveSession<a class="reference internal" href="_modules/mcp_server_webcrawl/interactive/session.html#InteractiveSession">[source]</a><a class="headerlink" href="#mcp_server_webcrawl.interactive.session.InteractiveSession" title="Link to this definition"></a></dt> <dd>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate">object</code></a> Main session coordinator that manages the interactive terminal application. Initialize the interactive session with crawler and data source. <dl class="py method"> <dt class="sig sig-object py" id="mcp_server_webcrawl.interactive.session.InteractiveSession.__init__"> __init__(crawler, datasrc)<a class="reference internal" href="_modules/mcp_server_webcrawl/interactive/session.html#InteractiveSession.__init__">[source]</a><a class="headerlink" href="#mcp_server_webcrawl.interactive.session.InteractiveSession.__init__" title="Link to this definition"></a></dt> <dd>Initialize the interactive session with crawler and data source. <dl class="field-list simple"> <dt class="field-odd">Parameters:</dt> <dd class="field-odd"><ul class="simple"> <li>crawler (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)">str</a>) – </li> <li>datasrc (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)">str</a>) – </li> </ul> </dd> </dl> </dd></dl> <dl class="py property"> <dt class="sig sig-object py" id="mcp_server_webcrawl.interactive.session.InteractiveSession.ui_state"> property ui_state: <a class="reference internal" href="#mcp_server_webcrawl.interactive.ui.UiState" title="mcp_server_webcrawl.interactive.ui.UiState">UiState</a><a class="headerlink" href="#mcp_server_webcrawl.interactive.session.InteractiveSession.ui_state" title="Link to this definition"></a></dt> <dd></dd></dl> <dl class="py property"> <dt class="sig sig-object py" id="mcp_server_webcrawl.interactive.session.InteractiveSession.ui_focused"> property ui_focused: <a class="reference internal" href="#mcp_server_webcrawl.interactive.ui.UiFocusable" title="mcp_server_webcrawl.interactive.ui.UiFocusable">UiFocusable</a><a class="headerlink" href="#mcp_server_webcrawl.interactive.session.InteractiveSession.ui_focused" title="Link to this definition"></a></dt> <dd></dd></dl> <dl class="py property"> <dt class="sig sig-object py" id="mcp_server_webcrawl.interactive.session.InteractiveSession.crawler"> property crawler: <a class="reference internal" href="mcp_server_webcrawl.crawlers.base.html#mcp_server_webcrawl.crawlers.base.crawler.BaseCrawler" title="mcp_server_webcrawl.crawlers.base.crawler.BaseCrawler">BaseCrawler</a><a class="headerlink" href="#mcp_server_webcrawl.interactive.session.InteractiveSession.crawler" title="Link to this definition"></a></dt> <dd></dd></dl> <dl class="py property"> <dt class="sig sig-object py" id="mcp_server_webcrawl.interactive.session.InteractiveSession.document"> property document: SearchDocumentView<a class="headerlink" href="#mcp_server_webcrawl.interactive.session.InteractiveSession.document" title="Link to this definition"></a></dt> <dd></dd></dl> <dl class="py property"> <dt class="sig sig-object py" id="mcp_server_webcrawl.interactive.session.InteractiveSession.results"> property results: SearchResultsView<a class="headerlink" href="#mcp_server_webcrawl.interactive.session.InteractiveSession.results" title="Link to this definition"></a></dt> <dd></dd></dl> <dl class="py property"> <dt class="sig sig-object py" id="mcp_server_webcrawl.interactive.session.InteractiveSession.searchform"> property searchform: SearchFormView<a class="headerlink" href="#mcp_server_webcrawl.interactive.session.InteractiveSession.searchform" title="Link to this definition"></a></dt> <dd></dd></dl> <dl class="py property"> <dt class="sig sig-object py" id="mcp_server_webcrawl.interactive.session.InteractiveSession.searchman"> property searchman: <a class="reference internal" href="#mcp_server_webcrawl.interactive.search.SearchManager" title="mcp_server_webcrawl.interactive.search.SearchManager">SearchManager</a><a class="headerlink" href="#mcp_server_webcrawl.interactive.session.InteractiveSession.searchman" title="Link to this definition"></a></dt> <dd></dd></dl> <dl class="py property"> <dt class="sig sig-object py" id="mcp_server_webcrawl.interactive.session.InteractiveSession.sites"> property sites: <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.13)">list</a>[<a class="reference internal" href="mcp_server_webcrawl.models.html#mcp_server_webcrawl.models.sites.SiteResult" title="mcp_server_webcrawl.models.sites.SiteResult">SiteResult</a>]<a class="headerlink" href="#mcp_server_webcrawl.interactive.session.InteractiveSession.sites" title="Link to this definition"></a></dt> <dd></dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="mcp_server_webcrawl.interactive.session.InteractiveSession.debug_add"> debug_add(msg)<a class="reference internal" href="_modules/mcp_server_webcrawl/interactive/session.html#InteractiveSession.debug_add">[source]</a><a class="headerlink" href="#mcp_server_webcrawl.interactive.session.InteractiveSession.debug_add" title="Link to this definition"></a></dt> <dd>Add line of debug. <dl class="field-list simple"> <dt class="field-odd">Parameters:</dt> <dd class="field-odd">msg (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)">str</a>) – </dd> <dt class="field-even">Return type:</dt> <dd class="field-even">None </dd> </dl> </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="mcp_server_webcrawl.interactive.session.InteractiveSession.debug_clear"> debug_clear()<a class="reference internal" href="_modules/mcp_server_webcrawl/interactive/session.html#InteractiveSession.debug_clear">[source]</a><a class="headerlink" href="#mcp_server_webcrawl.interactive.session.InteractiveSession.debug_clear" title="Link to this definition"></a></dt> <dd>Clear debug statements. <dl class="field-list simple"> <dt class="field-odd">Return type:</dt> <dd class="field-odd">None </dd> </dl> </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="mcp_server_webcrawl.interactive.session.InteractiveSession.run"> run()<a class="reference internal" href="_modules/mcp_server_webcrawl/interactive/session.html#InteractiveSession.run">[source]</a><a class="headerlink" href="#mcp_server_webcrawl.interactive.session.InteractiveSession.run" title="Link to this definition"></a></dt> <dd>Public interface to launch the interactive terminal application. <dl class="field-list simple"> <dt class="field-odd">Return type:</dt> <dd class="field-odd">None </dd> </dl> </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="mcp_server_webcrawl.interactive.session.InteractiveSession.set_ui_state"> set_ui_state(state, focus=None)<a class="reference internal" href="_modules/mcp_server_webcrawl/interactive/session.html#InteractiveSession.set_ui_state">[source]</a><a class="headerlink" href="#mcp_server_webcrawl.interactive.session.InteractiveSession.set_ui_state" title="Link to this definition"></a></dt> <dd>Transition between UI states cleanly. <dl class="field-list simple"> <dt class="field-odd">Parameters:</dt> <dd class="field-odd"><ul class="simple"> <li>state (<a class="reference internal" href="#mcp_server_webcrawl.interactive.ui.UiState" title="mcp_server_webcrawl.interactive.ui.UiState">UiState</a>) – </li> <li>focus (<a class="reference internal" href="#mcp_server_webcrawl.interactive.ui.UiFocusable" title="mcp_server_webcrawl.interactive.ui.UiFocusable">UiFocusable</a> | None) – </li> </ul> </dd> <dt class="field-even">Return type:</dt> <dd class="field-even">None </dd> </dl> </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="mcp_server_webcrawl.interactive.session.InteractiveSession.set_init_input_args"> set_init_input_args(crawler, datasrc)<a class="reference internal" href="_modules/mcp_server_webcrawl/interactive/session.html#InteractiveSession.set_init_input_args">[source]</a><a class="headerlink" href="#mcp_server_webcrawl.interactive.session.InteractiveSession.set_init_input_args" title="Link to this definition"></a></dt> <dd><dl class="field-list simple"> <dt class="field-odd">Parameters:</dt> <dd class="field-odd"><ul class="simple"> <li>crawler (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)">str</a>) – </li> <li>datasrc (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)">str</a>) – </li> </ul> </dd> <dt class="field-even">Return type:</dt> <dd class="field-even">None </dd> </dl> </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="mcp_server_webcrawl.interactive.session.InteractiveSession.set_init_crawler"> set_init_crawler(crawler)<a class="reference internal" href="_modules/mcp_server_webcrawl/interactive/session.html#InteractiveSession.set_init_crawler">[source]</a><a class="headerlink" href="#mcp_server_webcrawl.interactive.session.InteractiveSession.set_init_crawler" title="Link to this definition"></a></dt> <dd><dl class="field-list simple"> <dt class="field-odd">Parameters:</dt> <dd class="field-odd">crawler (<a class="reference internal" href="mcp_server_webcrawl.crawlers.base.html#mcp_server_webcrawl.crawlers.base.crawler.BaseCrawler" title="mcp_server_webcrawl.crawlers.base.crawler.BaseCrawler">BaseCrawler</a>) – </dd> <dt class="field-even">Return type:</dt> <dd class="field-even">None </dd> </dl> </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="mcp_server_webcrawl.interactive.session.InteractiveSession.set_init_sites"> set_init_sites(sites)<a class="reference internal" href="_modules/mcp_server_webcrawl/interactive/session.html#InteractiveSession.set_init_sites">[source]</a><a class="headerlink" href="#mcp_server_webcrawl.interactive.session.InteractiveSession.set_init_sites" title="Link to this definition"></a></dt> <dd><dl class="field-list simple"> <dt class="field-odd">Parameters:</dt> <dd class="field-odd">sites (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)">str</a>) – </dd> <dt class="field-even">Return type:</dt> <dd class="field-even">None </dd> </dl> </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="mcp_server_webcrawl.interactive.session.InteractiveSession.set_init_searchform"> set_init_searchform(searchform)<a class="reference internal" href="_modules/mcp_server_webcrawl/interactive/session.html#InteractiveSession.set_init_searchform">[source]</a><a class="headerlink" href="#mcp_server_webcrawl.interactive.session.InteractiveSession.set_init_searchform" title="Link to this definition"></a></dt> <dd><dl class="field-list simple"> <dt class="field-odd">Parameters:</dt> <dd class="field-odd">searchform (BaseCursesView) – </dd> <dt class="field-even">Return type:</dt> <dd class="field-even">None </dd> </dl> </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="mcp_server_webcrawl.interactive.session.InteractiveSession.get_theme_color_pair"> get_theme_color_pair(theme)<a class="reference internal" href="_modules/mcp_server_webcrawl/interactive/session.html#InteractiveSession.get_theme_color_pair">[source]</a><a class="headerlink" href="#mcp_server_webcrawl.interactive.session.InteractiveSession.get_theme_color_pair" title="Link to this definition"></a></dt> <dd><dl class="field-list simple"> <dt class="field-odd">Parameters:</dt> <dd class="field-odd">theme (<a class="reference internal" href="#mcp_server_webcrawl.interactive.ui.ThemeDefinition" title="mcp_server_webcrawl.interactive.ui.ThemeDefinition">ThemeDefinition</a>) – </dd> <dt class="field-even">Return type:</dt> <dd class="field-even"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)">int</a> | None </dd> </dl> </dd></dl> </dd></dl> </section> <section id="module-mcp_server_webcrawl.interactive.ui"> <h2>mcp_server_webcrawl.interactive.ui module<a class="headerlink" href="#module-mcp_server_webcrawl.interactive.ui" title="Link to this heading"></a></h2> <dl class="py class"> <dt class="sig sig-object py" id="mcp_server_webcrawl.interactive.ui.DocumentMode"> class DocumentMode<a class="reference internal" href="_modules/mcp_server_webcrawl/interactive/ui.html#DocumentMode">[source]</a><a class="headerlink" href="#mcp_server_webcrawl.interactive.ui.DocumentMode" title="Link to this definition"></a></dt> <dd>Bases: <a class="reference external" href="https://docs.python.org/3/library/enum.html#enum.Enum" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate">Enum</code></a> An enumeration. <dl class="py attribute"> <dt class="sig sig-object py" id="mcp_server_webcrawl.interactive.ui.DocumentMode.MARKDOWN"> MARKDOWN = 1<a class="headerlink" href="#mcp_server_webcrawl.interactive.ui.DocumentMode.MARKDOWN" title="Link to this definition"></a></dt> <dd></dd></dl> <dl class="py attribute"> <dt class="sig sig-object py" id="mcp_server_webcrawl.interactive.ui.DocumentMode.RAW"> RAW = 2<a class="headerlink" href="#mcp_server_webcrawl.interactive.ui.DocumentMode.RAW" title="Link to this definition"></a></dt> <dd></dd></dl> <dl class="py attribute"> <dt class="sig sig-object py" id="mcp_server_webcrawl.interactive.ui.DocumentMode.HEADERS"> HEADERS = 3<a class="headerlink" href="#mcp_server_webcrawl.interactive.ui.DocumentMode.HEADERS" title="Link to this definition"></a></dt> <dd></dd></dl> </dd></dl> <dl class="py class"> <dt class="sig sig-object py" id="mcp_server_webcrawl.interactive.ui.NavigationDirection"> class NavigationDirection<a class="reference internal" href="_modules/mcp_server_webcrawl/interactive/ui.html#NavigationDirection">[source]</a><a class="headerlink" href="#mcp_server_webcrawl.interactive.ui.NavigationDirection" title="Link to this definition"></a></dt> <dd>Bases: <a class="reference external" href="https://docs.python.org/3/library/enum.html#enum.Enum" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate">Enum</code></a> An enumeration. <dl class="py attribute"> <dt class="sig sig-object py" id="mcp_server_webcrawl.interactive.ui.NavigationDirection.UP"> UP = 1<a class="headerlink" href="#mcp_server_webcrawl.interactive.ui.NavigationDirection.UP" title="Link to this definition"></a></dt> <dd></dd></dl> <dl class="py attribute"> <dt class="sig sig-object py" id="mcp_server_webcrawl.interactive.ui.NavigationDirection.DOWN"> DOWN = 2<a class="headerlink" href="#mcp_server_webcrawl.interactive.ui.NavigationDirection.DOWN" title="Link to this definition"></a></dt> <dd></dd></dl> <dl class="py attribute"> <dt class="sig sig-object py" id="mcp_server_webcrawl.interactive.ui.NavigationDirection.LEFT"> LEFT = 3<a class="headerlink" href="#mcp_server_webcrawl.interactive.ui.NavigationDirection.LEFT" title="Link to this definition"></a></dt> <dd></dd></dl> <dl class="py attribute"> <dt class="sig sig-object py" id="mcp_server_webcrawl.interactive.ui.NavigationDirection.RIGHT"> RIGHT = 4<a class="headerlink" href="#mcp_server_webcrawl.interactive.ui.NavigationDirection.RIGHT" title="Link to this definition"></a></dt> <dd></dd></dl> </dd></dl> <dl class="py class"> <dt class="sig sig-object py" id="mcp_server_webcrawl.interactive.ui.ScrollDirection"> class ScrollDirection<a class="reference internal" href="_modules/mcp_server_webcrawl/interactive/ui.html#ScrollDirection">[source]</a><a class="headerlink" href="#mcp_server_webcrawl.interactive.ui.ScrollDirection" title="Link to this definition"></a></dt> <dd>Bases: <a class="reference external" href="https://docs.python.org/3/library/enum.html#enum.Enum" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate">Enum</code></a> An enumeration. <dl class="py attribute"> <dt class="sig sig-object py" id="mcp_server_webcrawl.interactive.ui.ScrollDirection.UP"> UP = 1<a class="headerlink" href="#mcp_server_webcrawl.interactive.ui.ScrollDirection.UP" title="Link to this definition"></a></dt> <dd></dd></dl> <dl class="py attribute"> <dt class="sig sig-object py" id="mcp_server_webcrawl.interactive.ui.ScrollDirection.DOWN"> DOWN = 2<a class="headerlink" href="#mcp_server_webcrawl.interactive.ui.ScrollDirection.DOWN" title="Link to this definition"></a></dt> <dd></dd></dl> </dd></dl> <dl class="py class"> <dt class="sig sig-object py" id="mcp_server_webcrawl.interactive.ui.SearchFilterType"> class SearchFilterType<a class="reference internal" href="_modules/mcp_server_webcrawl/interactive/ui.html#SearchFilterType">[source]</a><a class="headerlink" href="#mcp_server_webcrawl.interactive.ui.SearchFilterType" title="Link to this definition"></a></dt> <dd>Bases: <a class="reference external" href="https://docs.python.org/3/library/enum.html#enum.Enum" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate">Enum</code></a> An enumeration. <dl class="py attribute"> <dt class="sig sig-object py" id="mcp_server_webcrawl.interactive.ui.SearchFilterType.ANY"> ANY = 0<a class="headerlink" href="#mcp_server_webcrawl.interactive.ui.SearchFilterType.ANY" title="Link to this definition"></a></dt> <dd></dd></dl> <dl class="py attribute"> <dt class="sig sig-object py" id="mcp_server_webcrawl.interactive.ui.SearchFilterType.PAGES"> PAGES = 1<a class="headerlink" href="#mcp_server_webcrawl.interactive.ui.SearchFilterType.PAGES" title="Link to this definition"></a></dt> <dd></dd></dl> </dd></dl> <dl class="py class"> <dt class="sig sig-object py" id="mcp_server_webcrawl.interactive.ui.ThemeDefinition"> class ThemeDefinition<a class="reference internal" href="_modules/mcp_server_webcrawl/interactive/ui.html#ThemeDefinition">[source]</a><a class="headerlink" href="#mcp_server_webcrawl.interactive.ui.ThemeDefinition" title="Link to this definition"></a></dt> <dd>Bases: <a class="reference external" href="https://docs.python.org/3/library/enum.html#enum.Enum" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate">Enum</code></a> An enumeration. <dl class="py attribute"> <dt class="sig sig-object py" id="mcp_server_webcrawl.interactive.ui.ThemeDefinition.DOCUMENT_MODE"> DOCUMENT_MODE = (1, 1, 51)<a class="headerlink" href="#mcp_server_webcrawl.interactive.ui.ThemeDefinition.DOCUMENT_MODE" title="Link to this definition"></a></dt> <dd></dd></dl> <dl class="py attribute"> <dt class="sig sig-object py" id="mcp_server_webcrawl.interactive.ui.ThemeDefinition.HEADER_ACTIVE"> HEADER_ACTIVE = (2, 7, 17)<a class="headerlink" href="#mcp_server_webcrawl.interactive.ui.ThemeDefinition.HEADER_ACTIVE" title="Link to this definition"></a></dt> <dd></dd></dl> <dl class="py attribute"> <dt class="sig sig-object py" id="mcp_server_webcrawl.interactive.ui.ThemeDefinition.HEADER_INACTIVE"> HEADER_INACTIVE = (3, 7, 233)<a class="headerlink" href="#mcp_server_webcrawl.interactive.ui.ThemeDefinition.HEADER_INACTIVE" title="Link to this definition"></a></dt> <dd></dd></dl> <dl class="py attribute"> <dt class="sig sig-object py" id="mcp_server_webcrawl.interactive.ui.ThemeDefinition.HEADER_OUTER"> HEADER_OUTER = (4, 7, 235)<a class="headerlink" href="#mcp_server_webcrawl.interactive.ui.ThemeDefinition.HEADER_OUTER" title="Link to this definition"></a></dt> <dd></dd></dl> <dl class="py attribute"> <dt class="sig sig-object py" id="mcp_server_webcrawl.interactive.ui.ThemeDefinition.HELP_LINK"> HELP_LINK = (5, 7, 27)<a class="headerlink" href="#mcp_server_webcrawl.interactive.ui.ThemeDefinition.HELP_LINK" title="Link to this definition"></a></dt> <dd></dd></dl> <dl class="py attribute"> <dt class="sig sig-object py" id="mcp_server_webcrawl.interactive.ui.ThemeDefinition.HTTP_ERROR"> HTTP_ERROR = (6, 7, 88)<a class="headerlink" href="#mcp_server_webcrawl.interactive.ui.ThemeDefinition.HTTP_ERROR" title="Link to this definition"></a></dt> <dd></dd></dl> <dl class="py attribute"> <dt class="sig sig-object py" id="mcp_server_webcrawl.interactive.ui.ThemeDefinition.HTTP_WARN"> HTTP_WARN = (7, 7, 130)<a class="headerlink" href="#mcp_server_webcrawl.interactive.ui.ThemeDefinition.HTTP_WARN" title="Link to this definition"></a></dt> <dd></dd></dl> <dl class="py attribute"> <dt class="sig sig-object py" id="mcp_server_webcrawl.interactive.ui.ThemeDefinition.INACTIVE_QUERY"> INACTIVE_QUERY = (8, 245, 237)<a class="headerlink" href="#mcp_server_webcrawl.interactive.ui.ThemeDefinition.INACTIVE_QUERY" title="Link to this definition"></a></dt> <dd></dd></dl> <dl class="py attribute"> <dt class="sig sig-object py" id="mcp_server_webcrawl.interactive.ui.ThemeDefinition.SNIPPET_DEFAULT"> SNIPPET_DEFAULT = (9, 243, 0)<a class="headerlink" href="#mcp_server_webcrawl.interactive.ui.ThemeDefinition.SNIPPET_DEFAULT" title="Link to this definition"></a></dt> <dd></dd></dl> <dl class="py attribute"> <dt class="sig sig-object py" id="mcp_server_webcrawl.interactive.ui.ThemeDefinition.SNIPPET_HIGHLIGHT"> SNIPPET_HIGHLIGHT = (10, 232, 51)<a class="headerlink" href="#mcp_server_webcrawl.interactive.ui.ThemeDefinition.SNIPPET_HIGHLIGHT" title="Link to this definition"></a></dt> <dd></dd></dl> <dl class="py attribute"> <dt class="sig sig-object py" id="mcp_server_webcrawl.interactive.ui.ThemeDefinition.UI_ERROR"> UI_ERROR = (11, 7, 88)<a class="headerlink" href="#mcp_server_webcrawl.interactive.ui.ThemeDefinition.UI_ERROR" title="Link to this definition"></a></dt> <dd></dd></dl> </dd></dl> <dl class="py class"> <dt class="sig sig-object py" id="mcp_server_webcrawl.interactive.ui.UiFocusable"> class UiFocusable<a class="reference internal" href="_modules/mcp_server_webcrawl/interactive/ui.html#UiFocusable">[source]</a><a class="headerlink" href="#mcp_server_webcrawl.interactive.ui.UiFocusable" title="Link to this definition"></a></dt> <dd>Bases: <a class="reference external" href="https://docs.python.org/3/library/enum.html#enum.Enum" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate">Enum</code></a> An enumeration. <dl class="py attribute"> <dt class="sig sig-object py" id="mcp_server_webcrawl.interactive.ui.UiFocusable.UNDEFINED"> UNDEFINED = 1<a class="headerlink" href="#mcp_server_webcrawl.interactive.ui.UiFocusable.UNDEFINED" title="Link to this definition"></a></dt> <dd></dd></dl> <dl class="py attribute"> <dt class="sig sig-object py" id="mcp_server_webcrawl.interactive.ui.UiFocusable.SEARCH_FORM"> SEARCH_FORM = 2<a class="headerlink" href="#mcp_server_webcrawl.interactive.ui.UiFocusable.SEARCH_FORM" title="Link to this definition"></a></dt> <dd></dd></dl> <dl class="py attribute"> <dt class="sig sig-object py" id="mcp_server_webcrawl.interactive.ui.UiFocusable.SEARCH_RESULTS"> SEARCH_RESULTS = 3<a class="headerlink" href="#mcp_server_webcrawl.interactive.ui.UiFocusable.SEARCH_RESULTS" title="Link to this definition"></a></dt> <dd></dd></dl> </dd></dl> <dl class="py class"> <dt class="sig sig-object py" id="mcp_server_webcrawl.interactive.ui.UiState"> class UiState<a class="reference internal" href="_modules/mcp_server_webcrawl/interactive/ui.html#UiState">[source]</a><a class="headerlink" href="#mcp_server_webcrawl.interactive.ui.UiState" title="Link to this definition"></a></dt> <dd>Bases: <a class="reference external" href="https://docs.python.org/3/library/enum.html#enum.Enum" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate">Enum</code></a> An enumeration. <dl class="py attribute"> <dt class="sig sig-object py" id="mcp_server_webcrawl.interactive.ui.UiState.UNDEFINED"> UNDEFINED = 1<a class="headerlink" href="#mcp_server_webcrawl.interactive.ui.UiState.UNDEFINED" title="Link to this definition"></a></dt> <dd></dd></dl> <dl class="py attribute"> <dt class="sig sig-object py" id="mcp_server_webcrawl.interactive.ui.UiState.REQUIREMENTS"> REQUIREMENTS = 2<a class="headerlink" href="#mcp_server_webcrawl.interactive.ui.UiState.REQUIREMENTS" title="Link to this definition"></a></dt> <dd></dd></dl> <dl class="py attribute"> <dt class="sig sig-object py" id="mcp_server_webcrawl.interactive.ui.UiState.SEARCH_INIT"> SEARCH_INIT = 3<a class="headerlink" href="#mcp_server_webcrawl.interactive.ui.UiState.SEARCH_INIT" title="Link to this definition"></a></dt> <dd></dd></dl> <dl class="py attribute"> <dt class="sig sig-object py" id="mcp_server_webcrawl.interactive.ui.UiState.SEARCH_RESULTS"> SEARCH_RESULTS = 4<a class="headerlink" href="#mcp_server_webcrawl.interactive.ui.UiState.SEARCH_RESULTS" title="Link to this definition"></a></dt> <dd></dd></dl> <dl class="py attribute"> <dt class="sig sig-object py" id="mcp_server_webcrawl.interactive.ui.UiState.DOCUMENT"> DOCUMENT = 5<a class="headerlink" href="#mcp_server_webcrawl.interactive.ui.UiState.DOCUMENT" title="Link to this definition"></a></dt> <dd></dd></dl> <dl class="py attribute"> <dt class="sig sig-object py" id="mcp_server_webcrawl.interactive.ui.UiState.HELP"> HELP = 6<a class="headerlink" href="#mcp_server_webcrawl.interactive.ui.UiState.HELP" title="Link to this definition"></a></dt> <dd></dd></dl> </dd></dl> <dl class="py function"> <dt class="sig sig-object py" id="mcp_server_webcrawl.interactive.ui.safe_addstr"> safe_addstr(stdscr, y, x, text, style=0)<a class="reference internal" href="_modules/mcp_server_webcrawl/interactive/ui.html#safe_addstr">[source]</a><a class="headerlink" href="#mcp_server_webcrawl.interactive.ui.safe_addstr" title="Link to this definition"></a></dt> <dd>Safe addstr that handles screen edge errors. <dl class="field-list simple"> <dt class="field-odd">Parameters:</dt> <dd class="field-odd"><ul class="simple"> <li>stdscr (window) – </li> <li>y (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)">int</a>) – </li> <li>x (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)">int</a>) – </li> <li>text (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)">str</a>) – </li> <li>style (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)">int</a>) – </li> </ul> </dd> <dt class="field-even">Return type:</dt> <dd class="field-even">None </dd> </dl> </dd></dl> <dl class="py class"> <dt class="sig sig-object py" id="mcp_server_webcrawl.interactive.ui.InputRadio"> class InputRadio<a class="reference internal" href="_modules/mcp_server_webcrawl/interactive/ui.html#InputRadio">[source]</a><a class="headerlink" href="#mcp_server_webcrawl.interactive.ui.InputRadio" title="Link to this definition"></a></dt> <dd>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate">object</code></a> Radio input with 2-3 possible states (e.g., on/off or state1/state2/off) <dl class="field-list simple"> <dt class="field-odd">Parameters:</dt> <dd class="field-odd"><ul class="simple"> <li>group – The InputRadioGroup this radio belongs to</li> <li>name – The form radio group name</li> <li>label – The form radio label</li> <li>index – The current state index</li> <li>states – List of InputRadioState objects defining each possible state</li> </ul> </dd> </dl> <dl class="py method"> <dt class="sig sig-object py" id="mcp_server_webcrawl.interactive.ui.InputRadio.__init__"> __init__(group, name, label, index, states=None)<a class="reference internal" href="_modules/mcp_server_webcrawl/interactive/ui.html#InputRadio.__init__">[source]</a><a class="headerlink" href="#mcp_server_webcrawl.interactive.ui.InputRadio.__init__" title="Link to this definition"></a></dt> <dd>Radio input with 2-3 possible states (e.g., on/off or state1/state2/off) <dl class="field-list simple"> <dt class="field-odd">Parameters:</dt> <dd class="field-odd"><ul class="simple"> <li>group – The InputRadioGroup this radio belongs to</li> <li>name (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)">str</a>) – The form radio group name</li> <li>label (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)">str</a>) – The form radio label</li> <li>index (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)">int</a>) – The current state index</li> <li>states (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.13)">list</a> | None) – List of InputRadioState objects defining each possible state</li> </ul> </dd> </dl> </dd></dl> <dl class="py property"> <dt class="sig sig-object py" id="mcp_server_webcrawl.interactive.ui.InputRadio.current_state"> property current_state<a class="headerlink" href="#mcp_server_webcrawl.interactive.ui.InputRadio.current_state" title="Link to this definition"></a></dt> <dd>Get the current state </dd></dl> <dl class="py property"> <dt class="sig sig-object py" id="mcp_server_webcrawl.interactive.ui.InputRadio.display_label"> property display_label: <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)">str</a><a class="headerlink" href="#mcp_server_webcrawl.interactive.ui.InputRadio.display_label" title="Link to this definition"></a></dt> <dd>Get the current display label </dd></dl> <dl class="py property"> <dt class="sig sig-object py" id="mcp_server_webcrawl.interactive.ui.InputRadio.value"> property value: <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)">str</a><a class="headerlink" href="#mcp_server_webcrawl.interactive.ui.InputRadio.value" title="Link to this definition"></a></dt> <dd>Get the current value </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="mcp_server_webcrawl.interactive.ui.InputRadio.next_state"> next_state()<a class="reference internal" href="_modules/mcp_server_webcrawl/interactive/ui.html#InputRadio.next_state">[source]</a><a class="headerlink" href="#mcp_server_webcrawl.interactive.ui.InputRadio.next_state" title="Link to this definition"></a></dt> <dd>Cycle to the next state <dl class="field-list simple"> <dt class="field-odd">Return type:</dt> <dd class="field-odd">None </dd> </dl> </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="mcp_server_webcrawl.interactive.ui.InputRadio.render"> render(stdscr, y, x, field_index, max_width=None, focused=False)<a class="reference internal" href="_modules/mcp_server_webcrawl/interactive/ui.html#InputRadio.render">[source]</a><a class="headerlink" href="#mcp_server_webcrawl.interactive.ui.InputRadio.render" title="Link to this definition"></a></dt> <dd>Render a single radio option. <dl class="field-list simple"> <dt class="field-odd">Parameters:</dt> <dd class="field-odd"><ul class="simple"> <li>stdscr (window) – </li> <li>y (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)">int</a>) – </li> <li>x (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)">int</a>) – </li> <li>field_index (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)">int</a>) – </li> <li>max_width (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)">int</a> | None) – </li> <li>focused (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.13)">bool</a>) – </li> </ul> </dd> <dt class="field-even">Return type:</dt> <dd class="field-even">None </dd> </dl> </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="mcp_server_webcrawl.interactive.ui.InputRadio.set_state"> set_state(index)<a class="reference internal" href="_modules/mcp_server_webcrawl/interactive/ui.html#InputRadio.set_state">[source]</a><a class="headerlink" href="#mcp_server_webcrawl.interactive.ui.InputRadio.set_state" title="Link to this definition"></a></dt> <dd>Set the current state by index <dl class="field-list simple"> <dt class="field-odd">Parameters:</dt> <dd class="field-odd">index (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)">int</a>) – </dd> <dt class="field-even">Return type:</dt> <dd class="field-even">None </dd> </dl> </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="mcp_server_webcrawl.interactive.ui.InputRadio.set_states"> set_states(states)<a class="reference internal" href="_modules/mcp_server_webcrawl/interactive/ui.html#InputRadio.set_states">[source]</a><a class="headerlink" href="#mcp_server_webcrawl.interactive.ui.InputRadio.set_states" title="Link to this definition"></a></dt> <dd>Set the current state by index <dl class="field-list simple"> <dt class="field-odd">Parameters:</dt> <dd class="field-odd">states (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.13)">list</a>) – </dd> <dt class="field-even">Return type:</dt> <dd class="field-even">None </dd> </dl> </dd></dl> </dd></dl> <dl class="py class"> <dt class="sig sig-object py" id="mcp_server_webcrawl.interactive.ui.InputRadioGroup"> class InputRadioGroup<a class="reference internal" href="_modules/mcp_server_webcrawl/interactive/ui.html#InputRadioGroup">[source]</a><a class="headerlink" href="#mcp_server_webcrawl.interactive.ui.InputRadioGroup" title="Link to this definition"></a></dt> <dd>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate">object</code></a> Radio group with navigation and layout management capabilities. Radio input group with layout and navigation support. <dl class="field-list simple"> <dt class="field-odd">Parameters:</dt> <dd class="field-odd"><ul class="simple"> <li>name – The form radio group name (“filter”, “sort”, “site”, or “crawler”)</li> <li>sites – List of SiteResult objects, required only for “site” group type</li> </ul> </dd> </dl> <dl class="py method"> <dt class="sig sig-object py" id="mcp_server_webcrawl.interactive.ui.InputRadioGroup.__init__"> __init__(name, sites=None)<a class="reference internal" href="_modules/mcp_server_webcrawl/interactive/ui.html#InputRadioGroup.__init__">[source]</a><a class="headerlink" href="#mcp_server_webcrawl.interactive.ui.InputRadioGroup.__init__" title="Link to this definition"></a></dt> <dd>Radio input group with layout and navigation support. <dl class="field-list simple"> <dt class="field-odd">Parameters:</dt> <dd class="field-odd"><ul class="simple"> <li>name (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)">str</a>) – The form radio group name (“filter”, “sort”, “site”, or “crawler”)</li> <li>sites (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.13)">list</a> | None) – List of SiteResult objects, required only for “site” group type</li> </ul> </dd> </dl> </dd></dl> <dl class="py property"> <dt class="sig sig-object py" id="mcp_server_webcrawl.interactive.ui.InputRadioGroup.value"> property value: <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)">str</a><a class="headerlink" href="#mcp_server_webcrawl.interactive.ui.InputRadioGroup.value" title="Link to this definition"></a></dt> <dd></dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="mcp_server_webcrawl.interactive.ui.InputRadioGroup.calculate_group_width"> calculate_group_width()<a class="reference internal" href="_modules/mcp_server_webcrawl/interactive/ui.html#InputRadioGroup.calculate_group_width">[source]</a><a class="headerlink" href="#mcp_server_webcrawl.interactive.ui.InputRadioGroup.calculate_group_width" title="Link to this definition"></a></dt> <dd>Calculate the display width needed for a radio group. <dl class="field-list simple"> <dt class="field-odd">Return type:</dt> <dd class="field-odd"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)">int</a> </dd> </dl> </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="mcp_server_webcrawl.interactive.ui.InputRadioGroup.clear"> clear()<a class="reference internal" href="_modules/mcp_server_webcrawl/interactive/ui.html#InputRadioGroup.clear">[source]</a><a class="headerlink" href="#mcp_server_webcrawl.interactive.ui.InputRadioGroup.clear" title="Link to this definition"></a></dt> <dd><dl class="field-list simple"> <dt class="field-odd">Return type:</dt> <dd class="field-odd">None </dd> </dl> </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="mcp_server_webcrawl.interactive.ui.InputRadioGroup.set_layout_constraints"> set_layout_constraints(available_width, available_height, is_constrained=False)<a class="reference internal" href="_modules/mcp_server_webcrawl/interactive/ui.html#InputRadioGroup.set_layout_constraints">[source]</a><a class="headerlink" href="#mcp_server_webcrawl.interactive.ui.InputRadioGroup.set_layout_constraints" title="Link to this definition"></a></dt> <dd>Set layout constraints for grid-based groups (like sites). <dl class="field-list simple"> <dt class="field-odd">Parameters:</dt> <dd class="field-odd"><ul class="simple"> <li>available_width (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)">int</a>) – Available horizontal space</li> <li>available_height (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)">int</a>) – Available vertical space</li> <li>is_constrained (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.13)">bool</a>) – Whether layout is constrained (affects sites per column)</li> </ul> </dd> <dt class="field-even">Return type:</dt> <dd class="field-even">None </dd> </dl> </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="mcp_server_webcrawl.interactive.ui.InputRadioGroup.get_grid_position"> get_grid_position(radio_index)<a class="reference internal" href="_modules/mcp_server_webcrawl/interactive/ui.html#InputRadioGroup.get_grid_position">[source]</a><a class="headerlink" href="#mcp_server_webcrawl.interactive.ui.InputRadioGroup.get_grid_position" title="Link to this definition"></a></dt> <dd>Convert linear radio index to grid position. Only applies to site groups; other groups return (radio_index, 0). <dl class="field-list simple"> <dt class="field-odd">Parameters:</dt> <dd class="field-odd">radio_index (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)">int</a>) – Linear index in radios list </dd> <dt class="field-even">Returns:</dt> <dd class="field-even">(row, column) position in grid layout </dd> <dt class="field-odd">Return type:</dt> <dd class="field-odd"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.13)">tuple</a> </dd> </dl> </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="mcp_server_webcrawl.interactive.ui.InputRadioGroup.get_index_from_grid"> get_index_from_grid(row, col)<a class="reference internal" href="_modules/mcp_server_webcrawl/interactive/ui.html#InputRadioGroup.get_index_from_grid">[source]</a><a class="headerlink" href="#mcp_server_webcrawl.interactive.ui.InputRadioGroup.get_index_from_grid" title="Link to this definition"></a></dt> <dd>Convert grid position to linear radio index. Only works for site groups; returns None for other group types. <dl class="field-list simple"> <dt class="field-odd">Parameters:</dt> <dd class="field-odd"><ul class="simple"> <li>row (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)">int</a>) – Row in grid (0-based)</li> <li>col (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)">int</a>) – Column in grid (0-based)</li> </ul> </dd> <dt class="field-even">Returns:</dt> <dd class="field-even">Linear index if position exists within grid bounds, None otherwise </dd> <dt class="field-odd">Return type:</dt> <dd class="field-odd"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)">int</a> | None </dd> </dl> </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="mcp_server_webcrawl.interactive.ui.InputRadioGroup.navigate_left"> navigate_left(current_radio_index)<a class="reference internal" href="_modules/mcp_server_webcrawl/interactive/ui.html#InputRadioGroup.navigate_left">[source]</a><a class="headerlink" href="#mcp_server_webcrawl.interactive.ui.InputRadioGroup.navigate_left" title="Link to this definition"></a></dt> <dd>Navigate left within this group’s layout. <dl class="field-list simple"> <dt class="field-odd">Parameters:</dt> <dd class="field-odd">current_radio_index (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)">int</a>) – Current position in radios list </dd> <dt class="field-even">Returns:</dt> <dd class="field-even">New radio index if navigation successful, None if should exit group </dd> <dt class="field-odd">Return type:</dt> <dd class="field-odd"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)">int</a> | None </dd> </dl> </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="mcp_server_webcrawl.interactive.ui.InputRadioGroup.navigate_right"> navigate_right(current_radio_index)<a class="reference internal" href="_modules/mcp_server_webcrawl/interactive/ui.html#InputRadioGroup.navigate_right">[source]</a><a class="headerlink" href="#mcp_server_webcrawl.interactive.ui.InputRadioGroup.navigate_right" title="Link to this definition"></a></dt> <dd>Navigate right within this group’s layout. <dl class="field-list simple"> <dt class="field-odd">Parameters:</dt> <dd class="field-odd">current_radio_index (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)">int</a>) – Current position in radios list </dd> <dt class="field-even">Returns:</dt> <dd class="field-even">New radio index if navigation successful, None if should exit group </dd> <dt class="field-odd">Return type:</dt> <dd class="field-odd"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)">int</a> | None </dd> </dl> </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="mcp_server_webcrawl.interactive.ui.InputRadioGroup.navigate_to_row"> navigate_to_row(target_row, from_column=0)<a class="reference internal" href="_modules/mcp_server_webcrawl/interactive/ui.html#InputRadioGroup.navigate_to_row">[source]</a><a class="headerlink" href="#mcp_server_webcrawl.interactive.ui.InputRadioGroup.navigate_to_row" title="Link to this definition"></a></dt> <dd>Navigate to a specific row from an external column position. <dl class="field-list simple"> <dt class="field-odd">Parameters:</dt> <dd class="field-odd"><ul class="simple"> <li>target_row (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)">int</a>) – </li> <li>from_column (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)">int</a>) – </li> </ul> </dd> <dt class="field-even">Return type:</dt> <dd class="field-even"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)">int</a> | None </dd> </dl> </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="mcp_server_webcrawl.interactive.ui.InputRadioGroup.get_row_from_index"> get_row_from_index(radio_index)<a class="reference internal" href="_modules/mcp_server_webcrawl/interactive/ui.html#InputRadioGroup.get_row_from_index">[source]</a><a class="headerlink" href="#mcp_server_webcrawl.interactive.ui.InputRadioGroup.get_row_from_index" title="Link to this definition"></a></dt> <dd>Get the row number for navigation between groups. <dl class="field-list simple"> <dt class="field-odd">Parameters:</dt> <dd class="field-odd">radio_index (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)">int</a>) – Linear index in radios list </dd> <dt class="field-even">Returns:</dt> <dd class="field-even">Row number for inter-group navigation </dd> <dt class="field-odd">Return type:</dt> <dd class="field-odd"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)">int</a> </dd> </dl> </dd></dl> </dd></dl> <dl class="py class"> <dt class="sig sig-object py" id="mcp_server_webcrawl.interactive.ui.InputRadioState"> class InputRadioState<a class="reference internal" href="_modules/mcp_server_webcrawl/interactive/ui.html#InputRadioState">[source]</a><a class="headerlink" href="#mcp_server_webcrawl.interactive.ui.InputRadioState" title="Link to this definition"></a></dt> <dd>Bases: <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.NamedTuple" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate">NamedTuple</code></a> InputRadioState(label, value) Create new instance of InputRadioState(label, value) <dl class="py attribute"> <dt class="sig sig-object py" id="mcp_server_webcrawl.interactive.ui.InputRadioState.label"> label: <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)">str</a><a class="headerlink" href="#mcp_server_webcrawl.interactive.ui.InputRadioState.label" title="Link to this definition"></a></dt> <dd>Alias for field number 0 </dd></dl> <dl class="py attribute"> <dt class="sig sig-object py" id="mcp_server_webcrawl.interactive.ui.InputRadioState.value"> value: <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)">str</a><a class="headerlink" href="#mcp_server_webcrawl.interactive.ui.InputRadioState.value" title="Link to this definition"></a></dt> <dd>Alias for field number 1 </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="mcp_server_webcrawl.interactive.ui.InputRadioState.__new__"> static __new__(_cls, label, value)<a class="headerlink" href="#mcp_server_webcrawl.interactive.ui.InputRadioState.__new__" title="Link to this definition"></a></dt> <dd>Create new instance of InputRadioState(label, value) <dl class="field-list simple"> <dt class="field-odd">Parameters:</dt> <dd class="field-odd"><ul class="simple"> <li>label (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)">str</a>) – </li> <li>value (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)">str</a>) – </li> </ul> </dd> </dl> </dd></dl> </dd></dl> <dl class="py class"> <dt class="sig sig-object py" id="mcp_server_webcrawl.interactive.ui.InputText"> class InputText<a class="reference internal" href="_modules/mcp_server_webcrawl/interactive/ui.html#InputText">[source]</a><a class="headerlink" href="#mcp_server_webcrawl.interactive.ui.InputText" title="Link to this definition"></a></dt> <dd>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate">object</code></a> A reusable text input field with cursor management, rendering, and input handling. Consolidates the common text input functionality used across the application. Initialize the text input field. <dl class="field-list simple"> <dt class="field-odd">Parameters:</dt> <dd class="field-odd"><ul class="simple"> <li>initial_value – Starting text value</li> <li>max_length – Maximum allowed text length (None for unlimited)</li> <li>label – Display label for the field</li> </ul> </dd> </dl> <dl class="py method"> <dt class="sig sig-object py" id="mcp_server_webcrawl.interactive.ui.InputText.__init__"> __init__(initial_value='', max_length=None, label='')<a class="reference internal" href="_modules/mcp_server_webcrawl/interactive/ui.html#InputText.__init__">[source]</a><a class="headerlink" href="#mcp_server_webcrawl.interactive.ui.InputText.__init__" title="Link to this definition"></a></dt> <dd>Initialize the text input field. <dl class="field-list simple"> <dt class="field-odd">Parameters:</dt> <dd class="field-odd"><ul class="simple"> <li>initial_value (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)">str</a>) – Starting text value</li> <li>max_length (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)">int</a> | None) – Maximum allowed text length (None for unlimited)</li> <li>label (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)">str</a>) – Display label for the field</li> </ul> </dd> </dl> </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="mcp_server_webcrawl.interactive.ui.InputText.backspace"> backspace()<a class="reference internal" href="_modules/mcp_server_webcrawl/interactive/ui.html#InputText.backspace">[source]</a><a class="headerlink" href="#mcp_server_webcrawl.interactive.ui.InputText.backspace" title="Link to this definition"></a></dt> <dd>Remove the character before the cursor. <dl class="field-list simple"> <dt class="field-odd">Return type:</dt> <dd class="field-odd">None </dd> </dl> </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="mcp_server_webcrawl.interactive.ui.InputText.clear"> clear()<a class="reference internal" href="_modules/mcp_server_webcrawl/interactive/ui.html#InputText.clear">[source]</a><a class="headerlink" href="#mcp_server_webcrawl.interactive.ui.InputText.clear" title="Link to this definition"></a></dt> <dd>Clear all text and reset cursor. <dl class="field-list simple"> <dt class="field-odd">Return type:</dt> <dd class="field-odd">None </dd> </dl> </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="mcp_server_webcrawl.interactive.ui.InputText.delete"> delete()<a class="reference internal" href="_modules/mcp_server_webcrawl/interactive/ui.html#InputText.delete">[source]</a><a class="headerlink" href="#mcp_server_webcrawl.interactive.ui.InputText.delete" title="Link to this definition"></a></dt> <dd>Remove the character at the cursor position. <dl class="field-list simple"> <dt class="field-odd">Return type:</dt> <dd class="field-odd">None </dd> </dl> </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="mcp_server_webcrawl.interactive.ui.InputText.end"> end()<a class="reference internal" href="_modules/mcp_server_webcrawl/interactive/ui.html#InputText.end">[source]</a><a class="headerlink" href="#mcp_server_webcrawl.interactive.ui.InputText.end" title="Link to this definition"></a></dt> <dd>Move cursor to the end of the text. <dl class="field-list simple"> <dt class="field-odd">Return type:</dt> <dd class="field-odd">None </dd> </dl> </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="mcp_server_webcrawl.interactive.ui.InputText.handle_input"> handle_input(key)<a class="reference internal" href="_modules/mcp_server_webcrawl/interactive/ui.html#InputText.handle_input">[source]</a><a class="headerlink" href="#mcp_server_webcrawl.interactive.ui.InputText.handle_input" title="Link to this definition"></a></dt> <dd>Handle keyboard input for the text field. <dl class="field-list simple"> <dt class="field-odd">Parameters:</dt> <dd class="field-odd">key (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)">int</a>) – The curses key code </dd> <dt class="field-even">Returns:</dt> <dd class="field-even">True if the input was handled, False otherwise </dd> <dt class="field-odd">Return type:</dt> <dd class="field-odd"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.13)">bool</a> </dd> </dl> </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="mcp_server_webcrawl.interactive.ui.InputText.home"> home()<a class="reference internal" href="_modules/mcp_server_webcrawl/interactive/ui.html#InputText.home">[source]</a><a class="headerlink" href="#mcp_server_webcrawl.interactive.ui.InputText.home" title="Link to this definition"></a></dt> <dd>Move cursor to the beginning of the text. <dl class="field-list simple"> <dt class="field-odd">Return type:</dt> <dd class="field-odd">None </dd> </dl> </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="mcp_server_webcrawl.interactive.ui.InputText.insert_char"> insert_char(char)<a class="reference internal" href="_modules/mcp_server_webcrawl/interactive/ui.html#InputText.insert_char">[source]</a><a class="headerlink" href="#mcp_server_webcrawl.interactive.ui.InputText.insert_char" title="Link to this definition"></a></dt> <dd>Insert a character at the current cursor position. <dl class="field-list simple"> <dt class="field-odd">Parameters:</dt> <dd class="field-odd">char (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)">str</a>) – </dd> <dt class="field-even">Return type:</dt> <dd class="field-even">None </dd> </dl> </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="mcp_server_webcrawl.interactive.ui.InputText.is_empty"> is_empty()<a class="reference internal" href="_modules/mcp_server_webcrawl/interactive/ui.html#InputText.is_empty">[source]</a><a class="headerlink" href="#mcp_server_webcrawl.interactive.ui.InputText.is_empty" title="Link to this definition"></a></dt> <dd>Check if the text field is empty. <dl class="field-list simple"> <dt class="field-odd">Return type:</dt> <dd class="field-odd"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.13)">bool</a> </dd> </dl> </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="mcp_server_webcrawl.interactive.ui.InputText.move_cursor_left"> move_cursor_left()<a class="reference internal" href="_modules/mcp_server_webcrawl/interactive/ui.html#InputText.move_cursor_left">[source]</a><a class="headerlink" href="#mcp_server_webcrawl.interactive.ui.InputText.move_cursor_left" title="Link to this definition"></a></dt> <dd>Move cursor one position to the left. <dl class="field-list simple"> <dt class="field-odd">Return type:</dt> <dd class="field-odd">None </dd> </dl> </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="mcp_server_webcrawl.interactive.ui.InputText.move_cursor_right"> move_cursor_right()<a class="reference internal" href="_modules/mcp_server_webcrawl/interactive/ui.html#InputText.move_cursor_right">[source]</a><a class="headerlink" href="#mcp_server_webcrawl.interactive.ui.InputText.move_cursor_right" title="Link to this definition"></a></dt> <dd>Move cursor one position to the right. <dl class="field-list simple"> <dt class="field-odd">Return type:</dt> <dd class="field-odd">None </dd> </dl> </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="mcp_server_webcrawl.interactive.ui.InputText.render"> render(stdscr, y, x, width, focused=False, style=None)<a class="reference internal" href="_modules/mcp_server_webcrawl/interactive/ui.html#InputText.render">[source]</a><a class="headerlink" href="#mcp_server_webcrawl.interactive.ui.InputText.render" title="Link to this definition"></a></dt> <dd>Render the text input field with box, text, and cursor. <dl class="field-list simple"> <dt class="field-odd">Parameters:</dt> <dd class="field-odd"><ul class="simple"> <li>stdscr (window) – The curses window</li> <li>y (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)">int</a>) – Y position to render at</li> <li>x (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)">int</a>) – X position to render at</li> <li>width (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)">int</a>) – Total width of the input box</li> <li>focused (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.13)">bool</a>) – Whether this field has focus (shows cursor)</li> <li>style (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)">int</a> | None) – Curses style attributes to apply</li> </ul> </dd> <dt class="field-even">Return type:</dt> <dd class="field-even">None </dd> </dl> </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="mcp_server_webcrawl.interactive.ui.InputText.set_value"> set_value(new_value)<a class="reference internal" href="_modules/mcp_server_webcrawl/interactive/ui.html#InputText.set_value">[source]</a><a class="headerlink" href="#mcp_server_webcrawl.interactive.ui.InputText.set_value" title="Link to this definition"></a></dt> <dd>Set the text value and adjust cursor if needed. <dl class="field-list simple"> <dt class="field-odd">Parameters:</dt> <dd class="field-odd">new_value (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)">str</a>) – </dd> <dt class="field-even">Return type:</dt> <dd class="field-even">None </dd> </dl> </dd></dl> </dd></dl> <dl class="py class"> <dt class="sig sig-object py" id="mcp_server_webcrawl.interactive.ui.ViewBounds"> class ViewBounds<a class="reference internal" href="_modules/mcp_server_webcrawl/interactive/ui.html#ViewBounds">[source]</a><a class="headerlink" href="#mcp_server_webcrawl.interactive.ui.ViewBounds" title="Link to this definition"></a></dt> <dd>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate">object</code></a> <dl class="py method"> <dt class="sig sig-object py" id="mcp_server_webcrawl.interactive.ui.ViewBounds.__init__"> __init__(x=0, y=0, width=0, height=0)<a class="reference internal" href="_modules/mcp_server_webcrawl/interactive/ui.html#ViewBounds.__init__">[source]</a><a class="headerlink" href="#mcp_server_webcrawl.interactive.ui.ViewBounds.__init__" title="Link to this definition"></a></dt> <dd><dl class="field-list simple"> <dt class="field-odd">Parameters:</dt> <dd class="field-odd"><ul class="simple"> <li>x (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)">int</a>) – </li> <li>y (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)">int</a>) – </li> <li>width (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)">int</a>) – </li> <li>height (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)">int</a>) – </li> </ul> </dd> </dl> </dd></dl> </dd></dl> </section> <section id="module-mcp_server_webcrawl.interactive"> <h2>Module contents<a class="headerlink" href="#module-mcp_server_webcrawl.interactive" title="Link to this heading"></a></h2> </section> </section> </div> </div> <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> <a href="mcp_server_webcrawl.extras.html" class="btn btn-neutral float-left" title="mcp_server_webcrawl.extras package" accesskey="p" rel="prev"> Previous</a> <a href="mcp_server_webcrawl.models.html" class="btn btn-neutral float-right" title="mcp_server_webcrawl.models package" accesskey="n" rel="next">Next </a> </div> <hr/> <div role="contentinfo"> © Copyright 2025, pragmar. </div> Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. </footer> </div> </div> </section> </div> <script> jQuery(function () { SphinxRtdTheme.Navigation.enable(true); }); </script> </body> </html>

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/pragmar/mcp_server_webcrawl'

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