Windtools MCP

🚀 WindTools MCP Server

The MCP server for WindTools Code Assistant, providing document embedding and retrieval capabilities using ChromaDB and sentence transformers.

🚀 Quick Start

When the server starts, it automatically reads code files from the specified directory and embeds them into ChromaDB. Make sure all environment variables are correctly configured, especially WINDTOOLS_HOME and CHROMA_DB_URL. After startup, the server listens on a specific port, waiting for client connections and requests.

✨ Features

• Semantic Code Search: Embed and retrieve code snippets using sentence transformers.
• Codebase Indexing: Automatically index code files from a specified directory.
• Persistent Storage: Save code embeddings in ChromaDB for persistent retrieval.
• Directory Exploration: Built - in tools for navigating and exploring the codebase.
• Background Initialization: Asynchronously load resources to minimize startup time.
• Environment Configuration: Configurable via environment variables.

💻 Usage Examples

Basic Usage

Client Connection

curl -X POST http://localhost:5000/api/list_dir

Indexing the Codebase

python scripts/index_codebase.py --directory /path/to/your/code

📚 Documentation

Toolset

1. list_dir

   • List the contents of a directory.
   • Input:
     • directory_path (string): The absolute path of the directory whose contents you want to list.
   • Output:
     • Return all files and sub - directories in the specified directory.

2. get_file_content

   • Get the content of a specified file.
   • Input:
     • file_path (string): The absolute path of the target file.
   • Output:
     • Return the file content, or an error message if the file does not exist.

3. search_code

   • Search the codebase based on keywords.
   • Input:
     • keywords (list): A list of keywords to search for.
   • Output:
     • Return the location and content of matching code snippets.

Setup Instructions

Environment Variable Configuration

• WINDTOOLS_HOME: Specify the installation directory of WindTools, defaulting to the current working directory.
• CHROMA_DB_URL: The URL address of the ChromaDB service, defaulting to a locally running instance.
• SENTENCE_CONVERTER_PATH: The path to the executable file of the sentence converter, which must be executable.

Installation

1. Install Dependencies:

   pip install chroma-db sentence-transformers
   

2. Start the Server:

   python -m windtools_mcp.server start
   

3. Configuration Example:

   export WINDTOOLS_HOME=/path/to/windtools
   export CHROMA_DB_URL=http://localhost:8000
   

Development Requirements

• Code Structure: Follow the standard Python project structure to ensure clear dependencies between modules.
• Test Coverage: Use pytest and pytest - asyncio for comprehensive testing to ensure all functions work properly.

Test Command

pytest tests/

Project Structure

src/
  windtools_mcp/
    __init__.py
    __main__.py
    server.py
tests/
  test_client.py
  test_unit.py
.github/
  workflows/
    publish.yml
    test.yml
.gitignore
.python-version
pyproject.toml
README.md
VERSION

Release Process

• Version Management: Managed uniformly in the VERSION file.
• Automated Release:
  1. Update the version number in the VERSION file.
  2. Commit to the main branch.
  3. The GitHub Actions workflow automatically executes:
     • Create a Git tag named v{VERSION}.
     • Publish to GitHub and PyPI.

🔧 Technical Details

• ChromaDB: Used for storing and retrieving code embeddings, supporting efficient text search.
• Sentence Transformers: Responsible for converting code snippets into vector representations for similarity calculation.
• Asynchronous Processing: Manage resource loading and query requests through asynchronous tasks to improve system response speed.

📄 License

This MCP server is licensed under the MIT License. This means you can freely use, modify, and distribute the software, but you must comply with the terms and conditions of the MIT License.