-
Notifications
You must be signed in to change notification settings - Fork 6
BYOC MCP Prompts #281
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
BYOC MCP Prompts #281
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pls check my comments and revise accordingly
docs/tutorials/deploy-to-aws.mdx
Outdated
``` | ||
|
||
## Step 2 - Authenticate Defang to use your AWS Account | ||
### Step 2 - Authenticate Defang to use your AWS Account |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not sure about this "Authenticate Defang " terminology - should it be something like "Allow Defang to use your AWS Account"? (similar for other cloud providers)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hmm, the word “Authenticate” was already there before, so I thought I’d just leave it. But in this case, we’re not really authenticating with Defang—we’re authenticating into AWS so that Defang can use your credentials.
I think this wording works better: “Allow Defang to use your AWS Account.” It’s simpler and easier to understand for readers at all levels.
docs/tutorials/deploy-to-aws.mdx
Outdated
## Step 2 - Authenticate Defang to use your AWS Account | ||
### Step 2 - Authenticate Defang to use your AWS Account | ||
|
||
There are many ways to authenticate your [AWS account](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-authentication.html). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We are missing a 'with' - "There are many ways to authenticate with your..."
docs/tutorials/deploy-to-aws.mdx
Outdated
* or, the AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY, and AWS_REGION arguments | ||
|
||
### Step 3 - Deploy | ||
Once the prompt completes without errors, your chat input will be automatically populated with the deployment command for the LLM to execute. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we should replace "LLM" in this sentence with "IDE".
docs/tutorials/deploy-to-gcp.mdx
Outdated
``` | ||
|
||
## Step 2 - Authenticate Defang to use your GCP Account | ||
### Step 2 - Authenticate Defang to use your GCP Account |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not sure about this "Authenticate Defang " terminology - should it be something like "Allow Defang to use your GCP Account"?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Same as above:
## Step 2 - Authenticate Defang to use your GCP Account | ||
### Step 2 - Authenticate Defang to use your GCP Account | ||
|
||
After signing in to your GCP account, select an existing project or [create a new project](https://developers.google.com/workspace/guides/create-project). Make sure [billing is enabled](https://cloud.google.com/billing/docs/how-to/modify-project). Then, note down the project ID and set it as environment variable `GCP_PROJECT_ID`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do we need a link to instructions on how to sign in to the GCP account (similar to how we have that for AWS)?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Well not really because we have a list of pre recs and they have to have all that to be able to use this feature. Unless you think we should point that out specifically here.
https://github.com/DefangLabs/defang-docs/pull/281/files#diff-1eba8d9c0631215162beb78c17860fd9be34a65ec489fa858da41f2bfd21c7e2R10-R16
docs/tutorials/deploy-to-gcp.mdx
Outdated
 | ||
::: | ||
|
||
### Step 2 - Authenticate Defang to use your GCP Account |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There are 2 step 2's.
Also, this step is missing in the AWS/MCP section above - shouldn't either both have it or neither?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think this is the best place to put this information. I think it would be better if we created a separate tutorial dedicated to Deploying with the Defang MCP Server. You should also update the concepts page (docs/concepts/mcp.md
)
Yes, we are going to update the mcp.md in a different PR based on the time to release. |
@KevyVo why update it in a separate PR? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
lgtm
I did not create any new files besides adding images. I am not sure if this best place to add the instruction for BYOC MCP prompts but I extended the existing tutorials. I am welcoming any feedback, there is better place to put it.
Tech Debt: updated Railpack doc of supported providers
Related to this PR: DefangLabs/defang#1409