Skip to content

chore(docs): view updated language in mcp-server documentation#1146

Merged
MicBun merged 1 commit into
mainfrom
fix-mcp-docs
Sep 8, 2025
Merged

chore(docs): view updated language in mcp-server documentation#1146
MicBun merged 1 commit into
mainfrom
fix-mcp-docs

Conversation

@angelicawill
Copy link
Copy Markdown
Contributor

@angelicawill angelicawill commented Sep 8, 2025

Description

  • Fixed some grammatical issues in MCP server documentation

Summary by CodeRabbit

  • Documentation
    • Improved headings, grammar, and clarity across the MCP server guide.
    • Added a new Installation step describing how to explore TRUF.NETWORK data with AI (e.g., ask about stream IDs, providers, and run calculations or get suggestions).
    • Enhanced readability with better spacing around code blocks and section breaks.
    • Clarified supported AI client wording.
    • Refined Troubleshooting layout for easier scanning.
    • Fixed minor formatting issues (indentation, code fence newline).

@angelicawill angelicawill self-assigned this Sep 8, 2025
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Sep 8, 2025

Walkthrough

Edits to docs/mcp-server.md update headings, fix grammar, adjust spacing/formatting around sections and code blocks, and add a fourth installation step describing AI-based exploration of TRUF.NETWORK data. No code, APIs, or executable logic changed.

Changes

Cohort / File(s) Summary of Changes
Docs copy/formatting
docs/mcp-server.md
Renamed a heading; grammar/typo fixes; added spacing around code blocks and sections; inserted a new Installation step 4 describing AI-driven data exploration; ensured proper code fence/newline; improved subsection separation and bullet readability.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

  • docs: MCP server #1122 — Also modifies docs/mcp-server.md, introducing the MCP server doc that this PR refines with text/format updates and an added installation step.

Suggested reviewers

  • MicBun

Poem

A rabbit paws the docs with care,
Tidies lines and whitespace there.
Adds a step—ask AI, explore!
Streams and IDs, insights pour.
Hop, hop—install with flair,
TRUF tales bright the guides now share. 🐇✨

✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch fix-mcp-docs

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@holdex
Copy link
Copy Markdown

holdex Bot commented Sep 8, 2025

Time Submission Status

Member Status Time Action Last Update
angelicawill ✅ Submitted 10min Update time Sep 8, 2025, 9:40 AM
MicBun ✅ Submitted 5min Update time Sep 9, 2025, 4:33 AM

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (6)
docs/mcp-server.md (6)

9-9: Minor grammar polish

“about support” reads more naturally.

-Please inquire for support for other clients.
+Please inquire about support for other clients.

31-40: Ubuntu note: Python 3.12 may not be in default repos

On several Ubuntu/Debian releases, sudo apt install python3.12 isn’t available without an additional repo (e.g., deadsnakes) or using pyenv. Recommend adding a brief fallback note.


43-52: Windows prerequisite clarity

If using Chocolatey, mention installing Chocolatey first and that a new shell (or refreshenv) may be needed for PATH updates.


67-69: Tighten wording in config prompt

Slightly more formal and clearer.

-   - Database connection details (default: localhost:5432/kwild), just use the default if you didn't customize anything.
+   - Database connection details (default: localhost:5432/kwild). Use the default if you haven't customized your setup.

73-74: Reframe Step 4 to actionable “try it now” prompts (avoid marketing tone)

Make this step concrete with example prompts and remove promise-y claims.

-4. **Easily explore TRUF.NETWORK data with AI! Ask about specific stream IDs, data providers, and more—then let the AI help you run complex calculations or generate tailored suggestions before deciding how to use the data.**
+4. Open Claude Desktop and try:
+   - “Use postgres-mcp to list_schemas.”
+   - “get_object_details for schema kwild table streams.”
+   - “execute_sql: SELECT * FROM streams LIMIT 5;”
+   (Adjust prompts per your schema.)

92-96: Config path is OS-specific

Consider adding Windows/Linux paths alongside the macOS example to reduce confusion.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 065ec6e and 7471c39.

📒 Files selected for processing (1)
  • docs/mcp-server.md (6 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: acceptance-test
🔇 Additional comments (5)
docs/mcp-server.md (5)

5-6: Heading tweak LGTM

Clearer phrasing; improves readability.


21-29: Whitespace before code fence improves rendering

Good Markdown hygiene; keeps blocks from collapsing into lists.


59-66: Spacing before install block LGTM

Keeps list and code fence nicely separated.


86-91: Troubleshooting spacing LGTM

Improves scan-ability.


101-101: Trailing newline after code fence

Prevents Markdown rendering glitches. Good catch.

Copy link
Copy Markdown
Contributor

@MicBun MicBun left a comment

Choose a reason for hiding this comment

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

nice

@MicBun MicBun merged commit 0374344 into main Sep 8, 2025
7 checks passed
@MicBun MicBun deleted the fix-mcp-docs branch September 8, 2025 09:40
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.

2 participants