Skip to content

docs: create ARCHITECTURE.md #39

Description

@pmady

Summary

Create an ARCHITECTURE.md documenting the project's design and data flow. Foundation reviewers and new contributors need this to understand the codebase quickly.

Suggested sections

  1. Overview — what gpu-mcp-server does and where it fits
  2. Data flow — NVML → Collector → Handler → MCP SDK → Transport → Agent
  3. Key interfacesCollector (gpu.go), Handler (server.go)
  4. Build tagsnvml.go (cgo+linux), stub.go (everything else), mock.go (tests)
  5. Transport modes — stdio (default), HTTP (optional)
  6. Deployment — standalone binary, Docker, Kubernetes DaemonSet (Helm)
  7. MIG support — how MIG instances are detected and reported

Reference

See keda-gpu-scaler's ARCHITECTURE.md for the expected level of detail.

Acceptance criteria

  • ARCHITECTURE.md at repo root
  • Covers all sections above
  • Includes a text or Mermaid diagram of the data flow
  • Linked from README

Difficulty: Beginner-Intermediate — documentation, requires reading the code

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationgood first issueGood for newcomers

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions