Skip to content

docs: bilingual architecture doc (EN + RU)#10

Merged
BarisSozen merged 1 commit into
mainfrom
docs/architecture-doc
May 30, 2026
Merged

docs: bilingual architecture doc (EN + RU)#10
BarisSozen merged 1 commit into
mainfrom
docs/architecture-doc

Conversation

@BarisSozen
Copy link
Copy Markdown
Member

What

Adds a deep, bilingual architecture reference for @hashlock-tech/mcp, mirroring the hashlock-markets master-doc template and cross-linking back to it (and to the hashlock-sdk doc this package wraps).

  • docs/architecture/ARCHITECTURE.md (English)
  • docs/architecture/ARCHITECTURE.ru.md (Russian parity)
  • README now links to the doc (EN + RU)

Phase 2 of the architecture-docs effort — per-repo docs inside each core product sibling repo.

Shape (matches the template)

Language-switcher links · Mermaid diagrams (system-at-a-glance + tool-call sequence; English labels) · every non-obvious claim carries a path:line · mandatory "how this repo connects to hashlock-markets" section (§8).

Depth highlights

  • The thin-adapter-over-SDK design: 6 tools each forwarding to one @hashlock-tech/sdk method
  • The create_rfq intent compiler — the 59-line tool description is an LLM sub-prompt (EN+Turkish verb mapping, chain inference, restate-before-spend), pinned by tests
  • Two transports, same 6 tools: local stdio (this npm package) vs remote streamable-http (the backend mcp-gateway) — and an explicit "do NOT conflate with services/remote-mcp" note
  • Distribution across npm / MCP Registry / Smithery / Glama

Honest flags (surfaced, not fixed — out of scope for a docs PR)

§8 documents real drift rather than silently correcting it:

  • Endpoint default contradiction — code defaults to /graphql (correct; the comment explains /api/graphql 401s for external clients), but README/mcp-registry.json/smithery.yaml all document the broken /api/graphql default
  • Three version numberspackage.json 0.2.0, in-code McpServer 0.1.12, MCP-Registry 1.2.0
  • Stale legacy refsllms-install.md + .env.example cite the compromised 142.93.106.129 IP and the wrong package name @hashlock/mcp
  • CI runs no testsci.yml is install→lint→build only; the ~30-case suite runs only locally

Note: one small README fix included

The committed README's Links section ended mid-line with a truncated SIWE-login URL (](https://has — no closing paren, no newline). Since this PR appends an Architecture section right there, I completed that link to its unambiguous target (hashlock.markets/sign/login, already spelled out in the link text) rather than leave a visibly dangling link. No other content changed.

Verification

Mermaid fences balanced; mutual EN↔RU links resolve; every cited repo path exists. Docs-only (+ the one-line README link completion).

🤖 Generated with Claude Code

Add docs/architecture/ARCHITECTURE.md and ARCHITECTURE.ru.md — a deep,
file:line-backed architecture reference for the MCP server (thin-adapter-over-SDK
design, the 6 tools, the create_rfq intent compiler, stdio-vs-remote transports,
distribution surfaces), mirroring the hashlock-markets master-doc template and
cross-linking back to it (and to the hashlock-sdk doc it wraps). Link the README.

Also completes a pre-existing truncated SIWE-login link at the end of the README
Links section (the URL was cut mid-string in the committed file; its target is
the link text itself).

Phase 2 of the architecture-docs effort (per-repo sibling docs).

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 30, 2026

Warning

Review limit reached

@BarisSozen, we couldn't start this review because you've reached your PR review rate limit.

More reviews will be available in 48 minutes and 32 seconds. Learn how PR review limits work.

Your organization has run out of usage credits. Purchase more in the billing tab.

⌛ How to resolve this issue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans include higher PR review limits than trial, open-source, and free plans. In all cases, reviews become available again over time. During sustained high-volume PR review activity, CodeRabbit may temporarily slow when the next review becomes available.

Please see our Fair Usage Limits Policy for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: d7506a3b-8ae5-4a34-8562-0f9ada17946d

📥 Commits

Reviewing files that changed from the base of the PR and between 440a40d and c0a0335.

📒 Files selected for processing (3)
  • README.md
  • docs/architecture/ARCHITECTURE.md
  • docs/architecture/ARCHITECTURE.ru.md
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/architecture-doc

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

@BarisSozen BarisSozen merged commit 8593d58 into main May 30, 2026
4 checks passed
@BarisSozen BarisSozen deleted the docs/architecture-doc branch May 30, 2026 12:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant