Skip to content

(Reference, do not merge) Make Tiger CLI and MCP prominent across the docs - #375

Draft
atovpeko wants to merge 8 commits into
mainfrom
atovpeko/cli-mcp-docs-ia
Draft

(Reference, do not merge) Make Tiger CLI and MCP prominent across the docs#375
atovpeko wants to merge 8 commits into
mainfrom
atovpeko/cli-mcp-docs-ia

Conversation

@atovpeko

@atovpeko atovpeko commented Jul 1, 2026

Copy link
Copy Markdown
Collaborator

Describe your changes

Make Tiger CLI and Tiger MCP more prominent and discoverable across the docs:

  • Dedicated sections: new "Tiger CLI and MCP" concept page in Learn, a "Build with Tiger CLI and MCP" section in Build (common tasks + best practices for AI agents), and a dedicated Get started group. Split the old combined CLI/REST get-started page into separate "Get started with Tiger CLI" and "Get started with the REST API" pages.
  • Callouts: a reusable "Do this with your AI assistant" callout on the Build data how-to pages.
  • Tabs: Console/CLI tabs (plus an MCP callout) on the service-management Deploy pages that CLI/MCP actually support.
  • Reference structure: reformatted the Tiger CLI and Tiger MCP reference from large command tables into per-command/per-tool sections; consolidated the tiger mcp commands into the CLI reference.
  • Dropdown links: the Reference dropdown now lists Tiger CLI, Tiger MCP, and the REST API as separate entries instead of a single Tiger Cloud overview link (left sidebar unchanged).
  • Added repo links and a "file an issue" feedback CTA across the CLI/MCP pages.

Affected pages

Related Issues

Issue: #

Checklist before requesting a review

  • - This is ready for review. If not, raise as a draft PR
  • - I have reviewed my changes.
  • - I have confirmed the content is technically accurate.
  • - I have tested any code that is added or updated on the latest available version.
  • - I have confirmed the content is free of typos or grammar errors.
  • - I have verified all images and videos are clear and match production (or dev for unreleased features).
  • - This references a feature that is public. If not, add a note and we can schedule the merge for after the feature release.

Add dedicated Tiger CLI and MCP sections (Learn concept page, Build section, Get
started group), split the CLI/REST get-started page, add an AI-assistant callout on
Build data pages, add Console/CLI tabs on applicable service-management pages,
reformat the CLI and MCP reference into per-command sections, and surface Tiger CLI,
Tiger MCP, and the REST API as separate Reference dropdown entries.
@vercel

vercel Bot commented Jul 1, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
tiger-data-docs Ready Ready Preview, 💬 1 unresolved
✅ 2 resolved
Jul 8, 2026 2:27pm

The Tiger Cloud dropdown-expand rule matched the section label in every tab, which
also expanded the Learn tab's Tiger Cloud group. Key the expand set by tab label so
only the Reference dropdown is affected.
- Fill in the CLI tab on the AWS and Azure service management pages
  with reset-password, pause/resume, and delete commands; note that
  environment changes and free-to-standard conversion are Console-only
- Link agent best practices to the read-only database role page for
  defense in depth
- Make macOS the default Tiger CLI install tab and normalize the label

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

@solugebefola solugebefola left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM with minor points. One overarching thing is that the changes use "AI assistant" a lot, but I wonder if we should lean into "AI agent" instead, since that's the term that I hear most frequently

Comment thread src/components/DoWithAi.astro Outdated
Comment thread src/content/docs/build/continuous-aggregates/migrate-to-new-form.mdx Outdated
Comment thread src/content/docs/build/tiger-cli-mcp/common-tasks.mdx Outdated
Comment thread src/content/docs/build/tiger-cli-mcp/common-tasks.mdx Outdated
Comment thread src/content/docs/build/tiger-cli-mcp/common-tasks.mdx Outdated
Comment thread src/content/docs/learn/tiger-cli-mcp/index.mdx Outdated
Comment thread src/content/docs/get-started/quickstart/mcp-cli.mdx Outdated
Comment thread src/content/docs/get-started/quickstart/quickstart-5-minutes.mdx
Comment thread src/content/docs/get-started/quickstart/rest-api.mdx Outdated
Comment thread src/content/docs/build/columnar-storage/setup-hypercore.mdx
- Rename "AI assistant" to "AI agent" across CLI/MCP pages, quickstarts,
  reference pages, shared partials, and the get-started nav label
  (leaves the SQL assistant feature, changelog, and Eon example untouched)
- Retitle the DoWithAi callout to "Try this with your AI agent" so it
  reads as an alternative, not a prerequisite
- Move DoWithAi above the manual steps on migrate-to-new-form
- Apply wording fixes on common-tasks (clarify same service/data ops)
- Reword the read-only-role callout and extract it into a shared partial
  (_read-only-role-vs-agent-mode.mdx) used by AWS and Azure
- Add a password-reset warning to _service-management.mdx
- Small fixes on learn/index, mcp-cli, rest-api intro, and quickstart tip
- Extract the duplicated CLI-tab content from the AWS and Azure service
  management pages into a shared partial (_service-management-cli.mdx)
- Add a warning that resetting the password over the CLI breaks existing
  connections until connection details are updated
- Rename the two remaining "assistant" references to "agent" in the
  agent best-practices read-only role note
- Turn the "Manage your services" list on common-tasks into a
  CLI-command / agent-prompt table
- Replace the {C.CLI_REPO_URL} constant with the literal
  https://github.com/timescale/tiger-cli in the "File an issue" links
@atovpeko atovpeko changed the title Make Tiger CLI and MCP prominent across the docs (Reference, do not merge) Make Tiger CLI and MCP prominent across the docs Jul 10, 2026
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.

3 participants