Skip to content

Latest commit

 

History

History

README.md

swiggy-cli wiki

This wiki is the durable, deeply-linked knowledge base for the project. It is written for two audiences:

  • Humans browsing on GitHub.
  • Agents that load these markdown files into context.

Each page is self-contained, named after a single concept, and short enough to fit comfortably in a model's context window. Pages link out to source files at canonical paths (src/lib/...) so a reader can jump from concept → implementation in one click.

Index

  1. Architecture — how the layers fit together.
  2. Commands — every command, what it does, what it maps to.
  3. Tools catalog — verbatim list of upstream MCP tools.
  4. Output contract — JSON envelope, exit codes, error codes.
  5. Auth — OAuth flow, token storage, refresh.
  6. MCP protocol notes — transport, headers, manual replay.
  7. Skills — agent-skills shipped from this repo and how to install them.
  8. Extending — adding new commands or supporting new servers.
  9. Releasing — tag-based publish flow.
  10. Troubleshooting — common failures and fixes.

External references

Conventions

  • Code paths are absolute from the repo root, e.g. src/lib/mcp.ts.
  • "Server" always refers to one of the three Swiggy MCP servers: food, instamart, dineout.
  • "Tool" always refers to a single MCP tool (e.g. search_restaurants).
  • "Layer A" = ergonomic CLI verbs. "Layer B" = generic servers/tools/schema/call.