Skip to content

Conversation

KevyVo
Copy link
Contributor

@KevyVo KevyVo commented Sep 9, 2025

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

@KevyVo KevyVo self-assigned this Sep 9, 2025
@KevyVo KevyVo mentioned this pull request Sep 9, 2025
3 tasks
Copy link
Contributor

@Prakash-Sundaresan Prakash-Sundaresan left a 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

```

## Step 2 - Authenticate Defang to use your AWS Account
### Step 2 - Authenticate Defang to use your AWS Account
Copy link
Contributor

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)

Copy link
Contributor Author

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.

## 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).
Copy link
Contributor

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..."

* 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.
Copy link
Contributor

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".

```

## Step 2 - Authenticate Defang to use your GCP Account
### Step 2 - Authenticate Defang to use your GCP Account
Copy link
Contributor

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"?

Copy link
Contributor Author

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`.
Copy link
Contributor

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)?

Copy link
Contributor Author

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

![VS Code](/img/prompts/start-server.png)
:::

### Step 2 - Authenticate Defang to use your GCP Account
Copy link
Contributor

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?

Copy link
Member

@jordanstephens jordanstephens left a 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)

@KevyVo KevyVo requested a review from a team as a code owner September 9, 2025 21:51
@KevyVo
Copy link
Contributor Author

KevyVo commented Sep 9, 2025

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.

@jordanstephens
Copy link
Member

@KevyVo why update it in a separate PR?

Copy link
Contributor

@tokifyi tokifyi left a comment

Choose a reason for hiding this comment

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

lgtm

@jordanstephens jordanstephens merged commit 01264a2 into main Sep 9, 2025
4 checks passed
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.

4 participants