Skip to main content

AI Software Architect MCP Server that generates PRDs and provides reasoning assistance

Project description

mcp-server-architect

A Model Context Protocol server that acts as an AI Software Architect. It analyzes codebases to generate Product Requirements Documents (PRDs) and provides reasoning assistance for complex coding tasks.

Features

  • Analyze local codebase directories to understand project structure
  • Generate comprehensive PRDs or design documents for new features
  • Provide reasoning assistance for stuck LLMs on coding tasks
  • Integrates with Claude Code via MCP
  • Uses Google's Gemini Pro model for content generation
  • Easy to install and run with uvx mcp-server-architect

Prerequisites

  • Python 3.10 or higher
  • Google API key for Gemini Pro (get one from Google AI Studio)

Installation

Quick Installation with uv (Recommended)

The simplest way to install and use the server is with uv package manager:

# Install uv if not already installed
curl -LsSf https://astral.sh/uv/install.sh | sh

# No installation needed - run directly with uvx (one-liner)
env GEMINI_API_KEY=your_api_key_here uvx mcp-server-architect

Installation with pip

You can also install the package from PyPI:

pip install mcp-server-architect

After installation, you can run it as a command:

env GEMINI_API_KEY=your_api_key_here mcp-server-architect

API Key Requirements

This server requires a Gemini API key for accessing the Google Gemini model. You can obtain one from Google AI Studio. The API key can be provided in multiple ways:

  1. As an environment variable with the env prefix: env GEMINI_API_KEY=your_key mcp-server-architect
  2. Through a .env file in the current directory with GEMINI_API_KEY=your_key

Note: Setting the environment variable with export before running may not work reliably. The env command prefix is the recommended approach.

Development Installation

If you're developing or modifying the code:

  1. Clone the Repository:

    git clone <your-repo-url>
    cd <your-repo-directory>
    
  2. Setup Development Environment:

    uv venv
    source .venv/bin/activate
    uv pip install -e ".[dev]"
    
  3. Run in Development Mode:

    env GEMINI_API_KEY=your_api_key_here python -m mcp_server_architect
    
  4. Run with MCP Inspector for Development:

    env GEMINI_API_KEY=your_api_key_here npx @modelcontextprotocol/inspector python -m mcp dev --with-editable . mcp_server_architect/__main__.py
    

Running and Using the Server

Direct Execution with uvx

The easiest way to run the server is with uvx, passing your Gemini API key:

# As a one-liner (recommended)
env GEMINI_API_KEY=your_api_key_here uvx mcp-server-architect

# Alternatively, use a .env file in the current directory
# with GEMINI_API_KEY=your_api_key_here

Using with MCP Inspector

To debug or test the server with the MCP Inspector:

env GEMINI_API_KEY=your_api_key_here npx @modelcontextprotocol/inspector uvx mcp-server-architect

This will open an inspector interface (usually at http://localhost:8787) that allows you to test the server's tools interactively.

Adding to Claude Code

Claude Code supports MCP servers in various scopes. Here's how to add the Architect server with your Gemini API key:

# Local scope (only available to you in the current project)
claude mcp add architect -- env GEMINI_API_KEY=your_api_key_here uvx mcp-server-architect

# Project scope (shared with everyone via .mcp.json)
claude mcp add architect -s project -- env GEMINI_API_KEY=your_api_key_here uvx mcp-server-architect

# User scope (available to you across all projects)
claude mcp add architect -s user -- env GEMINI_API_KEY=your_api_key_here uvx mcp-server-architect

Important: Replace your_api_key_here with your actual Google API key for Gemini

Understanding MCP Server Scopes

Claude Code provides three different scopes for MCP servers:

  • Local (default): Available only to you in the current project
  • Project: Stored in a .mcp.json file that can be committed to version control and shared with your team
  • User: Available to you across all your projects

For team collaboration, the Project scope is recommended as it allows everyone on the team to access the same MCP servers without individual setup.

Storing API Keys Securely

For security, you may want to store your API key in a more secure way. You can:

  1. Use a .env file (in project scope):

    # Create a .env file (don't commit this!)
    echo "GEMINI_API_KEY=your_api_key_here" > .env
    
    # Add to Claude Code with the env prefix
    claude mcp add architect -- env GEMINI_API_KEY=your_api_key_here uvx mcp-server-architect
    
  2. Use your OS's secure credential storage:

    • On macOS, you can store it in Keychain and retrieve it with a script
    • Add the script reference in your command

Verifying Installation

After installation, you can verify the server is registered with Claude:

# List all configured servers
claude mcp list

# Get details for the architect server
claude mcp get architect

Running Tests

To run the test suite:

# Using uv
uv run pytest

# Using pip
python -m pytest

MCP Resources and Tools

This MCP server exposes the following resources and tools:

Tools

  • Architect::generate_prd: Generates a Product Requirements Document based on codebase analysis

    • Parameters:
      • task_description (required): Detailed description of the programming task or feature to implement
      • codebase_path (required): Local file path to the codebase directory to analyze
  • Architect::think: Provides reasoning assistance for a stuck LLM on a coding task

    • Parameters:
      • request (required): Detailed description of the coding task/issue and relevant code snippets

Usage Examples

Generate PRD Example

After installation, you can use the PRD tool in Claude Code by prompting:

@Architect please generate a PRD for creating a new feature.
Task Description: "Create a user profile page that displays user information and activity history, with edit functionality."
Codebase Path: "/path/to/your/local/project"

Example with more specific technical details:

@Architect generate a PRD for a new feature.
Task Description: "Implement JWT authentication in a Flask application, with login, registration, and token refresh endpoints. Add middleware for protected routes and handle token expiration gracefully."
Codebase Path: "/Users/username/projects/my-flask-app"

Reasoning Assistance Example

When you're stuck on a coding task, use the thinking tool to get detailed reasoning:

@Architect I need help thinking through a coding problem.
I'm trying to implement a function that reverses a linked list but I'm stuck on handling the edge cases.
Here's my code:
```python
def reverse_linked_list(head):
    if not head or not head.next:
        return head
    prev = None
    current = head
    while current:
        next_node = current.next
        current.next = prev
        prev = current
        current = next_node
    return prev

What edge cases am I missing? Is my implementation correct?


You can also create custom slash commands for easier access:

1. Create a commands directory in your project:
   ```bash
   mkdir -p .claude/commands
  1. Create command files for Architect tools:

    # PRD generation command
    echo "Generate a PRD for the following task:\n\nTask Description: \"$ARGUMENTS\"\nCodebase Path: \"`pwd`\"" > .claude/commands/prd.md
    
    # Thinking assistance command
    echo "I need help thinking through this coding problem:\n\n$ARGUMENTS" > .claude/commands/think.md
    
  2. Use them in Claude Code:

    # For PRD generation
    /project:prd Implement a new user authentication system
    
    # For reasoning assistance
    /project:think I'm trying to optimize this recursive function but hitting a stack overflow...
    

Building and Publishing

To build and publish the package to PyPI using uv:

  1. Build the package:

    uv build --no-sources
    

    This creates distribution packages in the dist/ directory.

  2. Publish to TestPyPI (optional but recommended):

    # Set your TestPyPI token
    export UV_PUBLISH_TOKEN=your_testpypi_token
    
    # Publish to TestPyPI
    uv publish --publish-url https://test.pypi.org/legacy/
    
  3. Publish to PyPI:

    # Set your PyPI token
    export UV_PUBLISH_TOKEN=your_pypi_token
    
    # Publish to PyPI
    uv publish
    

Release Steps Summary

Here's a summary of all steps to prepare and release a new version:

  1. Update version following semantic versioning (major.minor.patch) in:

    • pyproject.toml
    • mcp_server_architect/version.py
    • mcp_server_architect/__init__.py
  2. Make sure tests pass:

    uv run pytest
    
  3. Build the package:

    uv build --no-sources
    
  4. Test the package locally:

    # Create a temporary directory
    mkdir -p /tmp/test-architect
    cd /tmp/test-architect
    
    # Test installing from the built package
    uv run --with-pin /path/to/your/dist/mcp_server_architect-*.whl --no-project -- python -c "from mcp_server_architect import __version__; print(__version__)"
    
  5. Publish to PyPI:

    uv publish
    
  6. Verify the installation:

    # In a fresh environment
    uvx mcp-server-architect --version
    

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mcp_server_architect-0.1.7.tar.gz (60.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mcp_server_architect-0.1.7-py3-none-any.whl (13.5 kB view details)

Uploaded Python 3

File details

Details for the file mcp_server_architect-0.1.7.tar.gz.

File metadata

File hashes

Hashes for mcp_server_architect-0.1.7.tar.gz
Algorithm Hash digest
SHA256 f610ae9e99eda18f11dac0ef602fdffb3978a62730d4c62091e570ec6cf00757
MD5 da4a53119352a02efaee2103e2079853
BLAKE2b-256 667345462452534dcf3e6c33a4c110bc994a8e44c2fcee4ad229c94de34e2788

See more details on using hashes here.

File details

Details for the file mcp_server_architect-0.1.7-py3-none-any.whl.

File metadata

File hashes

Hashes for mcp_server_architect-0.1.7-py3-none-any.whl
Algorithm Hash digest
SHA256 9bc3cd1abe139c50316734d4d70153dc21b31ffc730c653b8380f68cb927bb87
MD5 5752e9f1ba319e493647d7432edc94b0
BLAKE2b-256 d02909036955fa562e99290e8686fa2d3c8d79ed80b971e6db7f5dbb4fda73e5

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page