Skip to content

Update Readme to redirect to the docs site#277

Closed
amychen1776 wants to merge 4 commits into
mainfrom
redirect_readme
Closed

Update Readme to redirect to the docs site#277
amychen1776 wants to merge 4 commits into
mainfrom
redirect_readme

Conversation

@amychen1776

Copy link
Copy Markdown
Contributor

Related to this issue #276

@amychen1776
amychen1776 requested review from a team, b-per and jasnonaz as code owners August 11, 2025 15:58
@amychen1776

Copy link
Copy Markdown
Contributor Author

I don't think this make sense to update the changelog so hopefully that's an okay failing test

Comment thread README.md Outdated
@b-per

b-per commented Aug 11, 2025

Copy link
Copy Markdown
Collaborator

As we now have more space in the README 😄, can we mention the examples folder?

With the docs on the official docs site, people landing here might be the more technical ones looking for how to integrate the MCP server into their agentic workflows.

@amychen1776

amychen1776 commented Aug 11, 2025

Copy link
Copy Markdown
Contributor Author

As we now have more space in the README 😄, can we mention the examples folder?

With the docs on the official docs site, people landing here might be the more technical ones looking for how to integrate the MCP server into their agentic workflows.

@b-per of course :) but what would you like to say? Since shouldn't folks integrating with their agentic workflows also be going to our docs?

I think it makes more sense to link back to those files in our docs to make it more consistent. We don't put "more technical" example in the dbt core repo either.

amychen1776 and others added 2 commits August 11, 2025 14:11
Co-authored-by: Devon Fulcher <24593113+DevonFulcher@users.noreply.github.com>
@b-per

b-per commented Aug 11, 2025

Copy link
Copy Markdown
Collaborator

As we now have more space in the README 😄, can we mention the examples folder?
With the docs on the official docs site, people landing here might be the more technical ones looking for how to integrate the MCP server into their agentic workflows.

@b-per of course :) but what would you like to say? Since shouldn't folks integrating with their agentic workflows also be going to our docs?

I think it makes more sense to link back to those files in our docs to make it more consistent. We don't put "more technical" example in the dbt core repo either.

Yes, we can add the examples to docs.getdbt.com, but they aren't added so far, are they?

@amychen1776

Copy link
Copy Markdown
Contributor Author

@b-per nope! not yet. we will want to write something more fully on it. Perhaps we start there?

@amychen1776

Copy link
Copy Markdown
Contributor Author

@DevonFulcher @b-per could we merge this in and then follow up with more?

Comment thread README.md
## Troubleshooting

- Some MCP clients may be unable to find `uvx` from the JSON config. If this happens, try finding the full path to `uvx` with `which uvx` on Unix systems and placing this full path in the JSON. For instance: `"command": "/the/full/path/to/uvx"`.
For integration guides, we do

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I think you meant to finish this part?

@DevonFulcher DevonFulcher left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Thank you!

@amychen1776
amychen1776 marked this pull request as draft August 14, 2025 13:56
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