Skip to content

Commit 10644f1

Browse files
authored
Merge pull request #1164 from emberjs/nvp/ember-mcp
Propose hosting ember-mcp
2 parents 86f9fdf + ae78638 commit 10644f1

File tree

1 file changed

+117
-0
lines changed

1 file changed

+117
-0
lines changed

text/1164-host-ember-mcp.md

Lines changed: 117 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,117 @@
1+
---
2+
stage: accepted
3+
start-date: 2026-01-26T00:00:00.000Z
4+
release-date: # In format YYYY-MM-DDT00:00:00.000Z
5+
release-versions:
6+
teams:
7+
- learning
8+
- cli
9+
prs:
10+
accepted: https://github.com/emberjs/rfcs/pull/1164
11+
project-link:
12+
suite:
13+
---
14+
15+
# Recommend hosting `ember-mcp` on emberjs.com
16+
17+
## Summary
18+
19+
Recommend `ember-mcp` as the default MCP server for Ember projects. The goal is simple: when people use AI tools, they should get current Ember APIs and modern patterns by default, not legacy advice.
20+
21+
## Motivation
22+
23+
AI assistants are now part of many workflows, but they regularly miss Ember-specific context. The common failures are predictable: classic-era patterns, wrong APIs for the Ember version in use, and shell commands that don’t match the repo’s package manager.
24+
25+
`ember-mcp` addresses this by giving AI tools a small set of focused capabilities:
26+
27+
- Search Ember docs (API, Guides, community)
28+
- Fetch targeted API references
29+
- Provide best-practice guidance for modern Ember
30+
- Provide version/migration info
31+
- Detect the correct package manager and suggest the right commands
32+
33+
The expected outcome is fewer wrong suggestions and less time spent “arguing with the bot.”
34+
35+
## Detailed design
36+
37+
MCP (Model Context Protocol) lets AI tools call external “tools” in a structured way. `ember-mcp` is an MCP server that exposes Ember documentation and related utilities.
38+
39+
### What we’re recommending
40+
41+
- The recommended package is `ember-mcp`.
42+
- The upstream project is https://github.com/ember-tooling/ember-mcp.
43+
44+
### Data source
45+
46+
`ember-mcp` loads and indexes aggregated Ember documentation at startup (API docs, Guides, community content, examples) from:
47+
48+
`https://nullvoxpopuli.github.io/ember-ai-information-aggregator/llms-full.txt`
49+
50+
### Client configuration
51+
52+
Any MCP-compatible client can run it via `npx`:
53+
54+
```json
55+
{
56+
"mcpServers": {
57+
"ember": {
58+
"command": "npx",
59+
"args": ["-y", "ember-mcp"]
60+
}
61+
}
62+
}
63+
```
64+
65+
### “Hosted” expectation
66+
67+
A public endpoint: `https://mcp.emberjs.com` (or similar) for the latest version
68+
69+
And then for versions:
70+
- `https://mcp.emberjs.com/beta`
71+
- `https://mcp.emberjs.com/v6.10.x`
72+
- `https://mcp.emberjs.com/v6.8.x`
73+
- etc
74+
75+
76+
## How we teach this
77+
78+
- Add a short “AI-assisted development” section to the Guides: what MCP is, when to use it, and the one configuration snippet above.
79+
- Add `ember-mcp` to the emberjs.com tooling page alongside Ember Inspector and linting tools.
80+
- Publish a short announcement post focused on practical examples (upgrades, API lookups, best practices).
81+
82+
## Disclaimer and safety
83+
84+
The ember-mcp server is a read-only source of documentation. The server itself does not offer any mutation actions. But like any MCP server, it may suggest a command to your agent that your agent will run, and you need to be responsible for securing your environment against dangerous or destructive actions by your agent.
85+
86+
This includes (but isn’t limited to):
87+
88+
- Deleting code
89+
- Deleting folders/files outside of your project
90+
- Unintended modifications to your codebase
91+
- Other adverse effects (including damage to your OS or machine)
92+
93+
It’s important to be explicit about responsibility: MCP implementations and their maintainers are not responsible for damage caused by running generated commands or applying generated changes.
94+
95+
Practical guidance:
96+
97+
- Review commands and diffs before applying them.
98+
- Use version control and keep backups.
99+
- Prefer running tools with least privileges (and in disposable environments when possible).
100+
101+
## Drawbacks
102+
103+
- Ongoing maintenance: `ember-mcp` needs regular updates as docs and best practices change.
104+
- Trust/safety: it’s a tool surface for AI agents; docs should encourage reviewing output and using version control.
105+
- Dependency on the aggregator URL staying available and current.
106+
107+
## Alternatives
108+
109+
- Do nothing (developers keep getting inconsistent, often outdated Ember advice).
110+
- “Just write better docs” (helps, but doesn’t give AI tools structured access).
111+
- Build editor-specific integrations (more maintenance, less portable than MCP).
112+
113+
## Unresolved questions
114+
115+
- Q: What’s the policy for changes to the doc aggregator source and inclusion criteria?
116+
- write more docs on emberjs.com
117+
- write blog posts

0 commit comments

Comments
 (0)