Make Tiger CLI and MCP docs reliable for AI agents - #455
Open
atovpeko wants to merge 3 commits into
Open
Conversation
Verifies and fixes the CLI/MCP reference, quickstarts, common tasks, cookbook, agent best practices, and the Console/CLI tab pages against the live product rather than the original review's claims alone. Highlights: - All 28 CLI commands now have real, verified sample output; fixed a wrong "auto-generated name" message, two table-alignment bugs, and a false claim that `config reset` logs you out. - MCP reference cross-checked against live tool schemas for all 13 tools; fixed `search_docs`'s required/optional fields to match the current schema. - Cookbook recipe corrected to not ask the agent to delete a fork, since there's no MCP tool for service delete. - Moved the CLI-to-MCP comparison table to the CLI/MCP overview page and made it comprehensive (service, database, and MCP-only tools), freeing common-tasks.mdx to use non-redundant question-style headings with tools linked to their reference entries. - Added an FAQ (with JSON-LD) to the CLI/MCP overview page; fixed a visible/structured-data mismatch and a false "same underlying capabilities" claim. - Change-resources and service-management pages: pulled HA-aware resize behavior and free-tier constraints forward from the Console-only tab, added real CLI output, and documented that the CLI doesn't enforce Console's production delete protection.
…cli-mcp-docs-ai-optimization
Re-ran the Tiger CLI and Tiger MCP docs against the live product: all 29 commands' flags, ~25 commands' output, all 13 MCP tool schemas, read-only mode, and all six cookbook recipes end to end. Commands or claims that were wrong: - `service resize --cpu 4 --memory 16` fails; CPU is in millicores. Fixed the reference and common-tasks, and stated the unit in the flag table. - `db test-connection` doesn't follow pg_isready conventions: 1 is a usage error and 2 covers both unreachable and rejected credentials. Rewrote the exit-code table from observed behavior and added the failure output. - `db create role --read-only` grants no table privileges, so an agent connecting as that role gets permission denied on every query. Noted on the flag and on the best-practices page. - `auth status` doesn't show a project ID under OAuth; what it lists depends on the login method. - The `service logs` sample wasn't the real format (no session ID, user, or SQLSTATE). Replaced with a captured sample, plus notes that timestamps use the client time zone and `--tail` counts entries, not lines. - Resizing a free service from the CLI converts it to a standard, billable one with no separate step. Moved the Console-only conversion requirement into the Console tab and documented the CLI behavior in the CLI tab. - Dropped the "about a minute to a couple of seconds" resize downtime figures: measured ~6s without HA and nothing detectable with HA. - `--pooled` needs a connection pooler on the service. Also: corrected the CLAUDE.md guardrails snippet (partial deny list, duplicate placeholders), matched the FAQ's JSON-LD to its visible answer, set the MCP quickstart's Prerequisites context to procedure, gave cookbook recipe 6 a setup line, and linked common-tasks to the reference for flags and sample output.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
✅ Checklist CompleteThank you for taking the time to properly review your PR! All checklist items are complete. |
atovpeko
changed the title
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.
Describe your changes
Makes the Tiger CLI and Tiger MCP docs reliable for AI agents to read and execute.
Affected pages
/build/tiger-cli-mcp/agent-best-practices
/build/tiger-cli-mcp/common-tasks
/build/tiger-cli-mcp/cookbook
/deploy/tiger-cloud/tiger-cloud-aws/security/client-credentials
/deploy/tiger-cloud/tiger-cloud-aws/service-management/change-resources
/deploy/tiger-cloud/tiger-cloud-aws/service-management/service-management
/deploy/tiger-cloud/tiger-cloud-azure/security/client-credentials
/deploy/tiger-cloud/tiger-cloud-azure/service-management/change-resources
/deploy/tiger-cloud/tiger-cloud-azure/service-management/service-management
/get-started/quickstart/mcp-cli
/get-started/quickstart/tiger-cli
/learn/tiger-cli-mcp
/reference/tiger-cloud/tiger-cli
/reference/tiger-cloud/tiger-mcp
🧪 Component kitchen sink — check for visual regressions if you changed components, styles, or dependencies.
Related Issues
Issue: none
Checklist before requesting a review