-
Notifications
You must be signed in to change notification settings - Fork 57
Restructure AI coding agents docs: skill-first, MCP as sub-pages #561
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
Merged
Merged
Changes from all commits
Commits
Show all changes
14 commits
Select commit
Hold shift + click to select a range
a25e60e
Reframe AI coding agents page: skill-first, MCP as subsection
davidfowl 8134989
Add Aspire MCP server sub-page
davidfowl f41c86b
Add Resource MCP servers page
davidfowl 844479c
Nest MCP pages under AI coding agents sidebar group
davidfowl fd57e3f
Add TypeScript tabs to all AppHost samples, add missing MCP tools
davidfowl a188826
Add 'Why Aspire for coding agents' section to overview
davidfowl 3fb09a1
Fix MCP server description — same data as CLI and dashboard
davidfowl 5b8810b
Reframe MCP server — same visibility for humans and agents
davidfowl 95dddb2
Lead 'Why Aspire' with runtime visibility, commands as supporting detail
davidfowl 497eb59
Rename 'Connection problems' to 'If your agent can't connect'
davidfowl 831aab1
Move MCP config JSON tabs from overview to MCP server page
davidfowl 8fb0d15
Rename configure-mcp to ai-coding-agents, add redirect
davidfowl 5f693af
Apply suggestions from code review
IEvangelist 663456b
Apply suggestions from code review
IEvangelist File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
168 changes: 168 additions & 0 deletions
168
src/frontend/src/content/docs/get-started/ai-coding-agents.mdx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,168 @@ | ||
| --- | ||
| title: Use AI coding agents | ||
| description: Set up your AI coding agents with skills, MCP servers, and browser automation tailored to Aspire. | ||
| --- | ||
|
|
||
| import { LinkCard, CardGrid } from '@astrojs/starlight/components'; | ||
| import { Aside, Steps, Tabs, TabItem, FileTree } from '@astrojs/starlight/components'; | ||
| import { Image } from 'astro:assets'; | ||
| import AsciinemaPlayer from '@components/AsciinemaPlayer.astro'; | ||
| import LoopingVideo from '@components/LoopingVideo.astro'; | ||
| import LearnMore from '@components/LearnMore.astro'; | ||
|
|
||
| Aspire provides a first-class setup experience for AI coding agents. Run `aspire agent init` in your project and your AI assistant — whether it's GitHub Copilot, Claude Code, or another MCP-compatible tool — can immediately understand, build, debug, and monitor your distributed applications. | ||
|
|
||
| ## Why Aspire for coding agents | ||
|
|
||
| Aspire gives coding agents the same visibility into your running application that a developer has. The resource data, structured logs, and distributed traces you see in the [Aspire Dashboard](/dashboard/overview/) are exposed to agents through the [Aspire MCP server](/get-started/aspire-mcp-server/) and the [Aspire CLI](/get-started/install-cli). Whether a person is debugging in the dashboard or an agent is diagnosing through MCP, they see the same picture. | ||
|
|
||
| The Aspire CLI is built for agent-driven workflows — every command works non-interactively to not block and prompts and supports `--format Json` for structured plain text output. Key commands include `aspire start` (background execution), `aspire start --isolated` (parallel worktrees), `aspire wait` (block until healthy), `aspire describe`, `aspire logs`, and `aspire docs search`. | ||
|
|
||
| The Aspire skill file (installed by `aspire agent init`) teaches agents all of these patterns automatically. | ||
|
|
||
| ## Get started | ||
|
|
||
| When you create a new Aspire project with `aspire new` or `aspire init`, you're prompted to configure AI agent environments. You can also run `aspire agent init` at any time to set up or update the configuration. | ||
|
|
||
| <Steps> | ||
|
|
||
| 1. Open a terminal in your Aspire project directory (the folder containing your AppHost). | ||
|
|
||
| 1. Run the following command: | ||
|
|
||
| ```bash title="Aspire CLI" | ||
| aspire agent init | ||
| ``` | ||
|
|
||
| 1. Select the components you want to configure: | ||
|
|
||
| - **Aspire skill file** (recommended) — teaches your AI agent how to use Aspire CLI commands | ||
| - **Playwright CLI** — enables browser automation for testing web resources | ||
| - **Aspire MCP server** — gives your AI agent runtime access to resources, logs, and traces | ||
|
|
||
| </Steps> | ||
|
|
||
| <AsciinemaPlayer | ||
| src="/casts/agent-init.cast" | ||
| poster="npt:0:08" | ||
| autoPlay={true} | ||
| cols={256} | ||
| rows={10} /> | ||
|
|
||
| ## What gets configured | ||
|
|
||
| The `aspire agent init` command detects your AI development environment and creates the appropriate configuration files: | ||
|
|
||
| ### Aspire skill file | ||
|
|
||
| The skill file teaches your AI coding agent how to work with Aspire. It includes a CLI command reference, key workflows (starting apps, debugging issues, adding integrations), and important rules to follow. The file is created in the format your agent expects: | ||
|
|
||
| <FileTree> | ||
|
|
||
| - .github/skills/aspire/ | ||
| - SKILL.md GitHub Copilot | ||
| - .claude/skills/aspire/ | ||
| - SKILL.md Claude Code | ||
|
|
||
| </FileTree> | ||
|
|
||
| The skill file guides your agent on how to: | ||
|
|
||
| - Start and manage your Aspire application (`aspire start`, `aspire stop`, `aspire describe`) | ||
| - Debug issues using structured logs and distributed traces | ||
| - Add integrations with `aspire add` and search documentation with `aspire docs` | ||
| - Use resource MCP tools for database queries and other resource-specific operations | ||
|
|
||
| ### Aspire MCP server | ||
|
|
||
| The MCP server gives your AI agent direct runtime access to your running Aspire application — resource status, logs, traces, and commands. See [Aspire MCP server](/get-started/aspire-mcp-server/) for configuration details, available tools, and the security model. | ||
|
|
||
| ## Migrate from AGENTS.md | ||
|
|
||
| If your project has an `AGENTS.md` file from a previous version of Aspire, you can migrate to the new skill file format. The skill file provides better structure and is recognized natively by AI coding agents. | ||
|
|
||
| <Steps> | ||
|
|
||
| 1. Run `aspire agent init` and select **Install Aspire skill file**. | ||
|
|
||
| 2. The skill files are created at `.github/skills/aspire/SKILL.md` and `.claude/skills/aspire/SKILL.md`. | ||
|
|
||
| 3. Review and delete the old `AGENTS.md` file — the skill file replaces it. | ||
|
|
||
| </Steps> | ||
|
|
||
| <Aside type="tip"> | ||
| The skill file is more structured than `AGENTS.md` and includes a complete CLI command reference table, workflow patterns, and rules that the agent follows automatically. You can customize it for your project's specific needs. | ||
| </Aside> | ||
|
|
||
| ## Your first prompts | ||
|
|
||
| Once configured, start your preferred AI coding environment. Try asking your agent: | ||
|
|
||
| > "Start the Aspire app and show me the resource status." | ||
|
|
||
| > "Analyze HTTP request performance for my API." | ||
|
|
||
| > "Add a Redis cache to my AppHost." | ||
|
|
||
| <Tabs> | ||
| <TabItem label="VS Code" id="demo-vscode"> | ||
| <LoopingVideo | ||
| aria-label="VS Code with GitHub Copilot using Aspire MCP to list resources" | ||
| controls={true} | ||
| sources={[ | ||
| { | ||
| src: "/mcp-vscode-list-resources.mp4", | ||
| type: "video/mp4", | ||
| title: "VS Code demonstrating Aspire MCP integration with GitHub Copilot" | ||
| } | ||
| ]} | ||
| /> | ||
| </TabItem> | ||
| <TabItem label="Claude Code" id="demo-claude"> | ||
| <AsciinemaPlayer | ||
| src="/casts/mcp-claudecode-cli.cast" | ||
| poster="npt:0:27" | ||
| autoPlay={true} | ||
| cols={256} | ||
| rows={28} /> | ||
| </TabItem> | ||
| <TabItem label="Copilot CLI" id="demo-copilot"> | ||
| <AsciinemaPlayer | ||
| src="/casts/mcp-copilot-cli.cast" | ||
| poster="npt:0:22" | ||
| autoPlay={true} | ||
| cols={256} | ||
| rows={28} /> | ||
| </TabItem> | ||
| <TabItem label="OpenCode" id="demo-opencode"> | ||
| <AsciinemaPlayer | ||
| src="/casts/mcp-opencode-cli.cast" | ||
| poster="npt:0:14" | ||
| autoPlay={true} | ||
| cols={256} | ||
| rows={28} /> | ||
| </TabItem> | ||
| </Tabs> | ||
|
|
||
| ## Supported AI assistants | ||
|
|
||
| The `aspire agent init` command supports the following AI assistants: | ||
|
|
||
| - [VS Code](https://code.visualstudio.com/docs/copilot/customization/mcp-servers) with GitHub Copilot | ||
| - [Copilot CLI](https://docs.github.com/en/copilot/how-tos/use-copilot-agents/use-copilot-cli#add-an-mcp-server) | ||
| - [Claude Code](https://docs.claude.com/en/docs/claude-code/mcp) | ||
| - [OpenCode](https://opencode.ai/docs/mcp-servers/) | ||
|
|
||
| <Aside type="note"> | ||
| The Aspire MCP server uses the STDIO transport protocol and may work with other agentic coding environments that support this MCP communication protocol. | ||
| </Aside> | ||
|
|
||
| ## See also | ||
|
|
||
| - [Aspire MCP server](/get-started/aspire-mcp-server/) — tools, security, and troubleshooting for the MCP server | ||
| - [aspire agent command](/reference/cli/commands/aspire-agent/) | ||
| - [aspire agent init command](/reference/cli/commands/aspire-agent-init/) | ||
| - [aspire agent mcp command](/reference/cli/commands/aspire-agent-mcp/) | ||
| - [Dashboard security considerations](/dashboard/security-considerations/) | ||
| - [GitHub Copilot in the Dashboard](/dashboard/copilot/) | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
Something about keepign it up to date? "Aspire will update your skill file if it's found" or "Manually update your skill file on aspire update" or whatever