Application connections tech preview (A.K.A. MCP OAuth)#7104
Conversation
Elastic Docs Style Checker (Vale)Summary: 3 warnings, 2 suggestions found
|
| File | Line | Rule | Message |
|---|---|---|---|
| deploy-manage/app-connections/connect-mcp-host.md | 29 | Elastic.DontUse | Don't use 'just'. |
| deploy-manage/app-connections/oauth-clients.md | 59 | Elastic.Spelling | 'revalidated' is a possible misspelling. |
| explore-analyze/ai-features/agent-builder/mcp-server-api-keys.md | 73 | Elastic.Latinisms | Latin terms and abbreviations are a common source of confusion. Use 'versus' instead of 'VS'. |
💡 Suggestions (2): Optional style improvements. Apply when helpful.
| File | Line | Rule | Message |
|---|---|---|---|
| deploy-manage/_snippets/app-connection-permissions.md | 3 | Elastic.Semicolons | Use semicolons judiciously. |
| explore-analyze/ai-features/agent-builder/mcp-server-api-keys.md | 34 | Elastic.WordChoice | Consider using 'run, start' instead of 'execute', unless the term is in the UI. |
The Vale linter checks documentation changes against the Elastic Docs style guide. To use Vale locally or report issues, refer to Elastic style guide for Vale.
Elastic Docs AI PR menuCheck the box to run an AI review for this pull request.
Powered by GitHub Agentic Workflows and docs-actions. For more information, reach out to the docs team. |
shainaraskas
changed the title
|
todo: disambiguation note on |
shainaraskas
changed the title
|
@leemthompo FYI, this would be good to include in the Agent Builder docs section as well |
|
@akm-esco yep that's tracked as part of this work:
|
|
FYI: opened #7329 as a temporary hidden stub for so elastic/kibana#277286 can link to a live URL while this full docs PR is still in progress. |
## Summary Adds a temporary hidden stub for /deploy-manage/app-connections/oauth-clients so elastic/kibana#277286 can link to a live docs URL before the full OAuth/application connections docs in #7104 merge. ## Changes - Adds a hidden TOC entry for deploy-manage/app-connections/oauth-clients.md. - Adds a minimal page with front matter and the oauth-clients anchor only. ## Follow-up Replace this stub with the full content from #7104 when that PR is ready.
|
@jakelandis I've done a pass of your comments and this is ready for another review. Re: "MCP client/server" vs. "OAuth client/server" terminology, I'm a bit confused about the intended term and could use a clarification. Some of the suggestions change "MCP client" to "OAuth client," like the Key concepts row and "creates an OAuth client", but a few spots still say "MCP client" for what looks like the same thing, like "Register a new MCP client" on the create page and "MCP clients can also be created through the Kibana API". The App connection row ends up using both in one sentence. I also wasn't sure how this should line up with the UI, which says Add MCP client and Manage MCP clients (OAuth), since the steps reference those labels. Can you tell me which term you want where? Mainly: what should the thing you create in Kibana be called in the docs, and should I match the UI labels in the task steps or use the new term everywhere? |
MCP client is a technical concept and the user never directly interacts with it. The MCP client is the technical code/library used inside of an MCP host such as Claude Code. It's the technical bits that know how to talk to an MCP server. OAuth client has 2 meanings.
I missed that copy .. it is technically wrong (I am being very pedantic) ...but I think it is abit more forgivable given the context of the application. We don't want to oversell how far that what you configure will work. It is technically an OAuth client that today only works with this exact MCP server. All said, I am being very pedantic and not very consistent and it probably doesn't matter that much. Moving the UI/UX outside of MCP to be more general OAuth (with MCP or without MCP) is on the very near roadmap, so I expect these docs and UI to change fairly soon. Using OAuth client is tiny bit more correct and future proof. |
jakelandis
left a comment
jakelandis
left a comment
There was a problem hiding this comment.
LGTM
Thanks ! These are really good!
eedugon
left a comment
eedugon
left a comment
There was a problem hiding this comment.
Such a complex PR and topic!
Great work, just adding some comments and suggestions for discussion.
leemthompo
left a comment
leemthompo
left a comment
There was a problem hiding this comment.
lgtm (with some minor macro suggestions shared in slack) 🚀
7 participants
What this adds
Docs for connecting MCP hosts to the agent builder MCP server with OAuth, alongside the existing API key method.
New pages:
Also: split API key setup into its own MCP server API keys page and trimmed MCP server to an overview plus an auth method comparison. Minor crosslink, terminology, and permissions updates.
How it's organized, and why
Open questions
Generative AI disclosure
Tool(s) and model(s) used: opus 4.8 plus a lot of elbow grease