Update README.md

[RadCod3]

Update README.md to reflect the current state of the project.

[coderabbitai]

📝 Walkthrough

Summary by CodeRabbit

• Documentation
  • Quick Start expanded to include Docker (recommended) and detailed local install paths.
  • MCP Tools section updated with revised tool counts, per-domain breakdown, and new bulk transaction operations.
  • Server configuration details expanded with new runtime options and OAuth relabeling.
  • Architecture and deployment docs reorganized for a modular, multi-layer approach and Docker/multi-platform guidance.
  • Development & CI/CD docs enhanced with image publishing, multi-platform builds, security scanning, and release workflow guidance.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

Walkthrough

README.md expanded: tool counts updated to 18 with added bulk transaction operations; Docker-first Quick Start and full local install added; server configuration and OAuth notes extended; architecture, deployment (Docker/multi-platform), CI/CD, and project structure sections reorganized and expanded.

Changes

Cohort / File(s)

Summary

Documentation README.md

Comprehensive documentation overhaul: tool count updated to 18 and bulk transaction tools added; Quick Start split into Docker (recommended) and Local Installation; new server-level config options (MCP_TRANSPORT, MCP_HOST, MCP_PORT, LOGGING_LEVEL) and OAuth relabeling; MCP tools re-categorized (Account/Transaction/Budget counts updated); modular multi-layer architecture and tool registration pattern introduced; Docker deployment details (images, platforms, compose) added; CI/CD workflows, multi-platform builds, security scanning, and release/contribution guidelines expanded; project directory layout clarified.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Poem

🐰 I hopped through lines of docs so neat,

Eighteen tools now tapping their feet,
Docker's warm burrow, a quick-start delight,
Configs and CI shining bright at night,
A rabbit cheers: "Docs polished just right!" 🥕

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Title check	❓ Inconclusive	The title 'Update README.md' is vague and generic, lacking specificity about what aspect of the README was updated or why.	Consider using a more descriptive title that highlights the main change, such as 'Add Docker deployment and bulk transaction features to README' or 'Expand README with current architecture and deployment details'.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description check	✅ Passed	The description is related to the changeset, stating it updates README to reflect current project state, which aligns with the comprehensive updates documented in the summary.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

---

📜 Recent review details

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between cacdebb and c9b78fb.

📒 Files selected for processing (1)

• README.md

🔇 Additional comments (9)

README.md (9)

18-46: Quick Start Docker section looks good.

The Docker Quick Start section is well-structured with both direct docker run and docker-compose examples. Code blocks have proper bash language specifiers and environment variable usage is clear and consistent.

---

59-79: Local Installation instructions are clear and well-formatted.

Prerequisite documentation, installation steps, and code examples follow a consistent pattern. The use of uv package manager is clearly indicated throughout.

---

90-105: Configuration section well-organized.

Server configuration options (MCP_TRANSPORT, MCP_HOST, MCP_PORT, LOGGING_LEVEL) are clearly separated from required configuration. The note that OAuth is optional and requires all three variables together is helpful context.

---

262-286: Project structure documentation accurate and clear.

The directory layout with tool counts (3, 10, 5 tools in respective modules) and file descriptions is well-organized and aligns with the claims elsewhere in the README.

---

288-310: Architecture section adds valuable implementation context.

The layered architecture explanation with tool registration pattern clarifies how FastMCP composition works. This helps contributors understand the modular design.

---

312-397: Docker Deployment and CI/CD documentation is comprehensive.

Clear separation of available images, deployment modes, and release process. The multi-platform support (amd64/arm64) and security scanning mention (Trivy) demonstrate production-readiness.

---

399-432: Contributing section provides clear workflow and style guidelines.

Contribution workflow is well-documented. Code style guidelines specify tabs, single quotes, 100-char line limit, and required type hints. Development commands are practical.

---

52-54: [Rewritten review comment]
[Classification tag]

---

3-3: All claims verified—tool count and Docker image publishing are accurate.

The 18 MCP tool count is correct (3 Account + 10 Transaction + 5 Budget tools), and Docker images are properly published to ghcr.io with multi-platform support (amd64/arm64) via the configured GitHub Actions workflow. No issues found.

---

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 1

🤖 Fix all issues with AI agents

In @README.md:
- Around line 260-286: Update the fenced code block under the "### Project
Structure" heading in README.md to include a language specifier (e.g., "text" or
"bash") so the block begins with ```text (or ```bash) instead of just ```, for
example the block that lists "LamPyrid/" and its tree; this satisfies MD040 and
keeps the rest of the content unchanged.

📜 Review details

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e7055d6 and cacdebb.

📒 Files selected for processing (1)

• README.md

🧰 Additional context used

🪛 markdownlint-cli2 (0.18.1)

README.md

262-262: Fenced code blocks should have a language specified

(MD040, fenced-code-language)

🔇 Additional comments (3)

README.md (3)

1-209: Documentation is clear, comprehensive, and well-structured.

The README effectively communicates the project's capabilities with practical examples. The Docker-first Quick Start is user-friendly, and the expanded configuration sections (Server Configuration, OAuth) provide helpful reference material. Claude Desktop integration options are well-documented with multiple deployment patterns.

---

288-310: Architecture section effectively documents the layered design pattern.

The revised architecture explanation clearly describes the server, tools, client, models, and configuration layers. The tool registration pattern using FastMCP's composition is well-documented, making the codebase approachable for contributors.

---

368-432: CI/CD, release, and contributing sections provide solid operational guidance.

The expanded descriptions of GitHub Actions workflows, release procedures, and code style guidelines (tabs for indentation, single quotes, 100-char line limit, type hints required) give contributors clear expectations and reduce friction for contributors.