Bounty #427: Add docs endpoint shortcuts

[Baijack-star]

Summary

Bounty #427 / Refs #427.

This adds a focused machine-readable shortcuts section to the public /docs page so contributors and agents can jump directly from the docs hub to the OpenAPI schema, open-bounty queue, open-bounty summary, latest accepted-work activity JSON, and the MCP JSON-RPC endpoint.

Before / After

Before: /docs linked to general docs and some API pages, but users still had to know or manually compose the exact machine-readable endpoints for schema discovery, open bounty prioritization, activity JSON, and MCP calls.

After: /docs exposes those exact entry points in one coherent section while keeping the existing documentation links unchanged.

Evidence

• Distinct from existing MRWK bounty: site UX and functional improvements #427 account, wallet, ledger, bounty-list, bounty-detail, proof, and activity workflow PRs; this targets the docs hub and machine-readable endpoint discovery.
• Live bounty preflight for internal bounty 73 / issue #427: status=open, awards_remaining=2, available_mrwk=250, and active attempts [].
• Scope: 2 files, +13/-0.

Validation

• PYTEST_DISABLE_PLUGIN_AUTOLOAD=1 ./.venv/bin/python -m pytest tests/test_api_mcp.py::test_docs_page_lists_live_ltclab_urls -q -> 1 passed
• ./.venv/bin/python -m ruff check tests/test_api_mcp.py -> passed
• ./.venv/bin/python -m ruff format --check tests/test_api_mcp.py -> 1 file already formatted
• git diff --check -> clean

Safety

No wallet material, private keys, cookies, OAuth state, access tokens, signatures, private data, price/off-ramp claims, liquidity claims, exchange claims, bridge promises, or fabricated payout claims are included.

Summary by CodeRabbit

• Documentation

  • Added OpenAPI JSON schema link to the docs page.
  • Introduced new "Machine-readable shortcuts" section featuring API query shortcuts and MCP JSON-RPC endpoint documentation links.

• Tests

  • Updated test coverage to verify new documentation links.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 18b5e16a-1906-4127-8d2e-d9c459b6ed5d

📥 Commits

Reviewing files that changed from the base of the PR and between d8532d4 and 5558816.

📒 Files selected for processing (2)

• app/templates/docs.html
• tests/test_api_mcp.py

---

📝 Walkthrough

Walkthrough

This PR adds new documentation shortcuts to the docs template: an OpenAPI JSON schema link, machine-readable API query shortcuts (bounties, summaries, activity), and an external MCP JSON-RPC endpoint link. The test is updated to validate these new links appear in the /docs response.

Changes

Documentation Shortcuts

Layer / File(s)	Summary
Documentation links and validation app/templates/docs.html, tests/test_api_mcp.py	OpenAPI JSON schema link added to "Project docs" section; new "Machine-readable shortcuts" subsection with API query URLs and MCP endpoint added. Test assertions expanded to check for all new href targets.

🚥 Pre-merge checks | ✅ 5 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Bounty Pr Focus	⚠️ Warning	Commit is a complete repository initialization (129 files, 21,887 insertions) claiming to be a 2-file PR (+13 lines) for Bounty #427, violating bounty scope focus.	Resubmit with only the two stated files: app/templates/docs.html and tests/test_api_mcp.py.

✅ Passed checks (5 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title 'Bounty #427: Add docs endpoint shortcuts' is concrete and clearly names the changed surface—adding machine-readable shortcuts to the docs endpoint.
Description check	✅ Passed	The description covers required elements: summary with bounty reference, evidence of distinct scope and bounty status, validation test results, and safety confirmation. It aligns with the template structure despite minor formatting variance.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Mergework Public Artifact Hygiene	✅ Passed	No investment, price, cash-out, or payout claims found. MRWK described as native project coin. Wallet section is technical, not a security disclosure.

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

---

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

[Baijack-star]

Local validation update after opening PR:

• PYTEST_DISABLE_PLUGIN_AUTOLOAD=1 ./.venv/bin/python -m pytest -q -> 414 passed

This is in addition to the focused docs-page test, Ruff check/format check, and git diff --check evidence in the PR body.

[Baijack-star]

CodeRabbit pre-merge focus warning appears to be using stale repository-initialization metadata. I rechecked the actual GitHub PR diff and local merge-base diff after the review:

• gh pr view 559 --json files shows only app/templates/docs.html (+8) and tests/test_api_mcp.py (+5).
• gh pr diff 559 --name-only shows the same two files.
• git diff --name-only origin/main...HEAD shows the same two files.
• PR has one commit, 555881631de5b9e299b0ccfbe364cb2e873519c0, based on d8532d4d909f47c689d3b88eb21461243097673f.

So the submitted scope matches the 2-file #427 docs-endpoint shortcut claim.

[tinyopsstudio]

Reviewed current PR #559 head 555881631de5b9e299b0ccfbe364cb2e873519c0 for docs endpoint shortcuts.

No blocker found.

Evidence checked:

• inspected app/templates/docs.html, tests/test_api_mcp.py, hosted CI status, and CodeRabbit output;
• confirmed /docs now links the OpenAPI JSON schema and adds machine-readable shortcuts for open bounties by available MRWK, open bounty summary, latest accepted-work activity JSON, and the MCP JSON-RPC endpoint;
• confirmed the docs page regression asserts the new shortcut links and existing Swagger UI surface;
• hosted Quality, readiness, docs, and image checks is green, and CodeRabbit reported no actionable comments;
• ran pytest tests/test_api_mcp.py::test_docs_page_lists_live_ltclab_urls -q: 1 passed;
• ran pytest tests/test_api_mcp.py -q with an isolated database URL: 76 passed;
• ran ruff check tests/test_api_mcp.py: all checks passed;
• ran ruff format --check tests/test_api_mcp.py: 1 file already formatted.

This looks mergeable from my reviewed slice.