Skip to main content

Architecture Guidelines MCP Server

Project description

ArchGuide MCP Server

Architecture Guidelines MCP Server - Inject architectural best practices and design patterns directly into your AI development workflow.

Features

  • 🏗️ Architecture Guidelines: Comprehensive guidelines for microservices, cloud-native, security patterns
  • 🔍 Smart Search: Full-text search across all guidelines and patterns
  • 🎯 Context-Aware: Filter by tech stack, scale, and domain
  • Compliance Checking: Validate designs against standards
  • 📚 Version Control: Support multiple versions of guidelines

Installation

Using pipx (Recommended)

pipx install archguide-mcp

Using pip

pip install archguide-mcp

Using uvx (no installation)

# Run directly without installing
uvx archguide-mcp

Configuration with Claude Code

Add to your Claude Code settings:

{
  "mcpServers": {
    "archguide": {
      "command": "archguide-mcp"
    }
  }
}

Or with uvx:

{
  "mcpServers": {
    "archguide": {
      "command": "uvx",
      "args": ["archguide-mcp"]
    }
  }
}

Usage

Once configured, you can use the architecture guidelines in your Claude Code conversations:

"Design a microservices architecture for an e-commerce platform"

"Show me the event sourcing pattern with examples"

"Check if this API design follows REST best practices"

"What are the security patterns for API authentication?"

Available Tools

get-architecture-guideline

Fetch guidelines for specific topics with context filtering:

  • Filter by tech stack (Java, Python, Node.js, etc.)
  • Filter by scale (startup, growth, enterprise)
  • Filter by domain (e-commerce, fintech, healthcare)

search-patterns

Search across all patterns and best practices

list-categories

Browse available guideline categories

check-compliance

Validate designs against architectural standards

Environment Variables

  • GUIDELINES_PATH: Custom path to guidelines directory
  • CACHE_TTL: Cache time-to-live in seconds (default: 300)
  • LOG_LEVEL: Logging level (DEBUG, INFO, WARNING, ERROR)

Contributing

Guidelines are written in Markdown with YAML frontmatter:

---
id: microservices-data-patterns
title: Data Management in Microservices
category: microservices
tags: [data, distributed-systems, patterns]
version: 1.0.0
techStack: [java, spring-boot, kafka]
applicability: [enterprise, cloud-native]
---

# Your guideline content here...

License

MIT License - see LICENSE file for details

Author

Ioan Salau (ioan.salau@gmail.com)

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

archguide_mcp-1.0.0.tar.gz (6.8 kB view details)

Uploaded Source

Built Distribution

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

archguide_mcp-1.0.0-py3-none-any.whl (6.2 kB view details)

Uploaded Python 3

File details

Details for the file archguide_mcp-1.0.0.tar.gz.

File metadata

  • Download URL: archguide_mcp-1.0.0.tar.gz
  • Upload date:
  • Size: 6.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for archguide_mcp-1.0.0.tar.gz
Algorithm Hash digest
SHA256 de147db8580b001f95c5e970615117c37786c4f03c03db7c736ea475ba94aa32
MD5 606389b943a5fc7f24c1f32674240270
BLAKE2b-256 059ad454cf56ab5bd59504751d5716fdd43e3e8a594e5353ad2e06418234a28a

See more details on using hashes here.

File details

Details for the file archguide_mcp-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: archguide_mcp-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 6.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for archguide_mcp-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 bff2f3f60347332033d76444415b9460a144fbf0f548e377672c137bd698765c
MD5 b8e63dd4b0829c26ac0809b16467d6ba
BLAKE2b-256 bacf126fbc552d2d34a05158730fb9727065b120f5c251728eec861ba855ffc8

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