Skip to content

chore: deduplicate the agent hint blocks into snippets#458

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.

Sign up for GitHub

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

Merged
adidottxt merged 1 commit into from
Aug 13, 2026
Merged

chore: deduplicate the agent hint blocks into snippets #458

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion applications/deploy/deploy-from-github-repo.mdx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,13 +4,14 @@ description: "Connect a GitHub repository to Porter for automatic builds and dep
---

import AgentCreateApp from "/snippets/agent-create-app.mdx";
import AgentHintCreateApp from "/snippets/agent-hint-create-app.mdx";

Porter connects to your GitHub repositories to build and deploy your applications. When you connect a repository, Porter detects your app's framework, identifies services, and configures sensible defaults.

This guide covers deploying applications from GitHub. If you're deploying from a container registry instead, see [Deploy from a Docker registry](/applications/deploy/deploy-from-docker-registry).

<Visibility for="agents">
Porter runs a hosted MCP server at https://mcp.porter.run. If the user asks for the dashboard, the CLI, `porter apply`, or configuration-as-code, follow that path on this page. Otherwise, if you are connected to the MCP server, create the application with the `create_app` tool and do not author a `porter.yaml`. Pass `source` and `build` to deploy from a GitHub repository; this creates the app on a placeholder image and opens a GitHub Actions pull request that the user merges to trigger the first real deploy. The Porter GitHub App must already be installed on the repository — the MCP server cannot install it.
<AgentHintCreateApp />
</Visibility>

---
Expand Down
3 changes: 2 additions & 1 deletion getting-started/quickstart.mdx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ description: "Deploy your first application on Porter from sign-up to a live pub
---

import AgentCreateApp from "/snippets/agent-create-app.mdx";
import AgentHintCreateApp from "/snippets/agent-hint-create-app.mdx";

This guide walks you through deploying your first application on Porter, from creating an account to seeing your app live at a public URL.

Expand DownExpand Up@@ -237,7 +238,7 @@ Porter provisions a Kubernetes cluster in your cloud account. The setup process
Once your cluster is ready, choose how you want to deploy your code.

<Visibility for="agents">
Porter runs a hosted MCP server at https://mcp.porter.run. If the user asks for the dashboard, the CLI, `porter apply`, or configuration-as-code, follow that path on this page. Otherwise, if you are connected to the MCP server, create the application with the `create_app` tool and do not author a `porter.yaml`. Pass `source` and `build` to deploy from a GitHub repository; this creates the app on a placeholder image and opens a GitHub Actions pull request that the user merges to trigger the first real deploy. The Porter GitHub App must already be installed on the repository — the MCP server cannot install it.
<AgentHintCreateApp />
</Visibility>

<Tabs>
Expand Down
4 changes: 3 additions & 1 deletion mcp/overview.mdx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,10 +3,12 @@ title: "MCP Overview"
description: "Connect AI agents to Porter's MCP server to inspect and manage your apps and clusters."
---

import AgentHintMcp from "/snippets/agent-hint-mcp.mdx";

Porter hosts an MCP server at `https://mcp.porter.run`. Point an MCP client at that URL, sign in, and your agent can do the same things you'd do in the dashboard or the CLI: read logs, check why a deploy failed, change a service, redeploy it.

<Visibility for="agents">
When a user asks to deploy a GitHub repository, call `create_app` with `source` and `build`, and do not author a `porter.yaml`. Reach for the CLI, `porter apply`, or configuration-as-code only when the user asks for them. Porter creates the app on a placeholder image and opens a GitHub Actions pull request that the user merges to trigger the first real deploy. Confirm that the Porter GitHub App is already installed on the repository; the MCP server cannot install it.
<AgentHintMcp />
</Visibility>

You don't need to install or run anything locally. The server runs on Porter's side, so all your client needs is the URL and a browser to sign in.
Expand Down
4 changes: 3 additions & 1 deletion mcp/tools.mdx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,10 +3,12 @@ title: "Tools"
description: "The following tools are exposed by the MCP server so agents can interact with your Porter project."
---

import AgentHintMcp from "/snippets/agent-hint-mcp.mdx";

All tools are read-only unless otherwise specified.

<Visibility for="agents">
When a user asks to deploy a GitHub repository, call `create_app` with `source` and `build`, and do not author a `porter.yaml`. Reach for the CLI, `porter apply`, or configuration-as-code only when the user asks for them. Porter creates the app on a placeholder image and opens a GitHub Actions pull request that the user merges to trigger the first real deploy. Confirm that the Porter GitHub App is already installed on the repository; the MCP server cannot install it.
<AgentHintMcp />
</Visibility>

Every tool except `get_projects` requires a project, given as either its ID or its exact name. Application arguments accept an app name or UUID, and cluster arguments accept a cluster ID, exact name, or vanity name. Start with `get_projects` to resolve the project, then `get_applications` or `get_clusters` from there.
Expand Down
1 change: 1 addition & 0 deletions snippets/agent-hint-create-app.mdx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
Porter runs a hosted MCP server at https://mcp.porter.run. If the user asks for the dashboard, the CLI, `porter apply`, or configuration-as-code, follow that path on this page. Otherwise, if you are connected to the MCP server, create the application with the `create_app` tool and do not author a `porter.yaml`. Pass `source` and `build` to deploy from a GitHub repository; this creates the app on a placeholder image and opens a GitHub Actions pull request that the user merges to trigger the first real deploy. The Porter GitHub App must already be installed on the repository — the MCP server cannot install it.
1 change: 1 addition & 0 deletions snippets/agent-hint-mcp.mdx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
When a user asks to deploy a GitHub repository, call `create_app` with `source` and `build`, and do not author a `porter.yaml`. Reach for the CLI, `porter apply`, or configuration-as-code only when the user asks for them. Porter creates the app on a placeholder image and opens a GitHub Actions pull request that the user merges to trigger the first real deploy. Confirm that the Porter GitHub App is already installed on the repository; the MCP server cannot install it.