# Welcome to GXtract's documentation!

<img src="/_static/images/gxtract-logo.png" alt="GXtract Logo" width="200" />

GXtract is a powerful and flexible Model Context Protocol (MCP) server with seamless GroundX tool integration. It enables efficient extraction of architectural and implementation details from various document types, with a focus on scientific papers and research articles.

This server is built with performance, scalability, and ease of use in mind, leveraging Python 3.12+, `asyncio`, and the FastMCP v2 library.

## Key Features

*   **High Performance:** Asynchronous architecture using `asyncio` and FastMCP v2.
*   **Cross-Platform:** Runs on Windows (AMD64, ARM64) and Linux (AMD64, ARM64).
*   **Extensible Tooling:** Easily integrate new tools and functionalities.
*   **GroundX Integration:** Out-of-the-box tools for interacting with GroundX services (search, query, explain semantic objects).
*   **Caching:** Efficient caching mechanism for GroundX metadata to improve performance and reduce API calls.
*   **Configurable:** Flexible configuration via CLI arguments and environment variables.
*   **Comprehensive Documentation:** Built with Sphinx for clarity and ease of understanding.

## Table of Contents

```{eval-rst}
.. toctree::
   :maxdepth: 2
   :caption: Getting Started

   overview.md
   installation.md
   configuration.md
   usage.md
```

```{eval-rst}
.. toctree::
   :maxdepth: 2
   :caption: Tools

   tools_docs/groundx.md
   tools_docs/cache_management.md
```

```{eval-rst}
.. toctree::
   :maxdepth: 2
   :caption: Development

   development.md
   architecture.md
   changelog.md
```

```{eval-rst}
.. toctree::
   :maxdepth: 1
   :caption: API Reference

   api/gxtract
   api/gxtract.tools
```

```{eval-rst}
.. toctree::
   :maxdepth: 1
   :caption: Project Info

   changelog.md
```

## Online Documentation

This documentation is also available online at [https://sascharo.github.io/gxtract/](https://sascharo.github.io/gxtract/).

The online documentation is automatically built and deployed whenever changes are pushed to the main branch of the repository, ensuring it's always up to date with the latest features and improvements.

## Indices and tables

```{eval-rst}
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
```