Skip to content

Conversation

@huskar-t
Copy link
Contributor

Description

docs: update usage examples in TDengine TSDB MCP reference manual

Issue(s)

Checklist

Please check the items in the checklist if applicable.

  • Is the user manual updated?
  • Are the test cases passed and automated?
  • Is there no significant decrease in test coverage?

Copilot AI review requested due to automatic review settings January 28, 2026 06:02
@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello @huskar-t, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request enhances the clarity and consistency of the TDengine TSDB MCP reference manual by introducing additional spacing around embedded images within the usage examples section. It also includes a correction for an image filename, ensuring that the documentation accurately reflects the intended visuals and improves overall presentation.

Highlights

  • Documentation Formatting: Improved readability of usage examples in both English and Chinese versions of the TDengine TSDB MCP reference manual by adding blank lines before image embeds for better visual separation.
  • Image Filename Correction: Corrected an image filename from "mcp-show.webp" to "mcp-show-databases.webp" for the 'Get database list' example in both documentation files.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Updates the TDengine TSDB MCP reference manual usage examples by refreshing the referenced screenshots and aligning the example sections in both Chinese and English docs.

Changes:

  • Replace the generic “show” screenshot with separate database and stable list screenshots.
  • Add/refresh MCP usage example screenshots (dnode list, database list, stable list; plus updated info screenshot in EN).
  • Adjust markdown formatting in the usage examples to consistently separate list items and embedded images.

Reviewed changes

Copilot reviewed 2 out of 14 changed files in this pull request and generated no comments.

Show a summary per file
File Description
docs/zh/14-reference/02-tools/08-mcp-tdengine-tsdb.md Updates usage example screenshot references and spacing in the Chinese manual.
docs/zh/14-reference/02-tools/assets/mcp-show.webp Removes the obsolete “show” screenshot asset no longer referenced.
docs/zh/14-reference/02-tools/assets/mcp-list-dnodes.webp Adds screenshot for “list dnodes” example (ZH).
docs/zh/14-reference/02-tools/assets/mcp-show-databases.webp Adds screenshot for “show databases” example (ZH).
docs/zh/14-reference/02-tools/assets/mcp-show-stables.webp Adds screenshot for “show stables” example (ZH).
docs/en/14-reference/02-tools/08-mcp-tdengine-tsdb.md Updates usage example screenshot references and spacing in the English manual.
docs/en/14-reference/02-tools/assets/mcp-show.webp Removes the obsolete “show” screenshot asset no longer referenced.
docs/en/14-reference/02-tools/assets/mcp-info.webp Adds/updates screenshot for “connection info” example (EN).
docs/en/14-reference/02-tools/assets/mcp-list-dnodes.webp Adds screenshot for “list dnodes” example (EN).
docs/en/14-reference/02-tools/assets/mcp-show-databases.webp Adds screenshot for “show databases” example (EN).
docs/en/14-reference/02-tools/assets/mcp-show-stables.webp Adds screenshot for “show stables” example (EN).

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request updates usage examples in the TDengine TSDB MCP reference manual for both English and Chinese versions. The changes primarily involve adding vertical spacing around images within numbered lists for better readability and updating one image filename. My review confirms the changes are beneficial, but I've identified some minor formatting inconsistencies in the new layout. I've provided suggestions to ensure uniform spacing across all list items, which will improve visual consistency and prevent potential rendering issues in the markdown.

@huskar-t huskar-t force-pushed the docs/xftan/fix-tsdb-mcp branch from 6eb7048 to 642868e Compare January 28, 2026 06:41
@zitsen zitsen merged commit 059f51d into main Jan 28, 2026
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants