docs: refresh README + MCP agent setup guidance#149
Merged
Conversation
The ADR-0004/ADR-0008 references in the self-host section pointed at docs/adr/, which is now gitignored (kept local, not public), leaving a dead link on the public repo. Drop the citations and point readers to the per-artifact docker/ and mcp/ READMEs for setup and design instead.
Add 🤗 Space badges and a 'Try it live' pointer for the hosted forecast explorer and talk slides, and list docker/, mcp/, and demo/ (with the api.py seam) in the Project Structure tree.
The paper's zero-shot MAE/RMSE tables report 12 TSFM variants; the README counted 13 by also listing Moirai-1.1-base, which has a config but no result row. Drop Base from the Supported Models Moirai row so the count matches the paper's reported evaluation.
…sections Replace the output-path bullet in At a Glance with a self-host & agents bullet (the path detail moves to a generated/git-ignored note after Quick Start). Move Project Structure below HPC so the run-environment sections stay together, and mark outputs/ and results/ as generated.
Add a Quick start and a 'Connect an agent / MCP client' section with host-agnostic setup (Claude Code, Codex CLI, Claude Desktop, Cursor, …) plus example prompts and tool-call flow. Remove the now-private docs/adr citations and the 'Why a dedicated server' section.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Documentation-only pass over the main README and the MCP artifact README, reflecting recent repo development and fixing references that went stale when the design docs moved local-only.
Main README
docs/adr/(now git-ignored / not public).docker/,mcp/,demo/in Project Structure; note theapi.pyseam.MCP README (
mcp/README.md)npx/uvxdrop-in).docs/adrcitations and the "Why a dedicated server" section.No code changes.