Skip to content

Conversation

@matzew
Copy link
Collaborator

@matzew matzew commented Oct 27, 2025

Adding initial set of document, adding a README as an overview for all of the content, and specific guides

  • for kubernetes
  • for agents, starting with 'claude code CLI'

Next PR will add VS code, similar to this blog

The Kubernetes guide is inspired by the referenced blog post, but does focus on just kubernetes

@matzew
Copy link
Collaborator Author

matzew commented Oct 27, 2025

For other "agents", like VS Code, or even Claude Desktop, I think creating screenshots makes more sense, rather than for the initial "Claude Code CLI", @manusa

…etes, as well as with 'claude code CLI'

Signed-off-by: Matthias Wessendorf <[email protected]>
@manusa
Copy link
Member

manusa commented Oct 27, 2025

I'll check thoroughly in a bit.

In the meantime, and related to his PR, one of the things I wanted to do was to update the main README.md Getting Started section to be more like the one in https://github.com/microsoft/playwright-mcp, with collapsible sections for each MCP Host/Client.

In scope of this PR (since it's focusing on Claude Code), maybe we can already add a collapsible

<details>
<summary>Claude Code</summary>
Follow the [dedicated MCP getting started guide]($linkToClaudeCodeGettingStarted) in our [user documentation].($linkToDocs)
</details>

to the main README.md too.

@Cali0707
Copy link
Collaborator

This looks great @matzew ! One question is, can we mention somewhere that all of the serviceaccount/custom kubeconfig is not technically necessary, but is recommended?

@matzew
Copy link
Collaborator Author

matzew commented Oct 27, 2025 via email

@matzew
Copy link
Collaborator Author

matzew commented Oct 27, 2025

@Cali0707 Added a note

@matzew
Copy link
Collaborator Author

matzew commented Oct 27, 2025

@manusa added the collapsible section for this new document.

For a general overhaul, we can use a separate PR - but I like the pattern of doing these sections!

Copy link
Member

@manusa manusa left a comment

Choose a reason for hiding this comment

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

Besides the comment about the namespace flag, everything else looks good. Thx!!!

@manusa manusa added this to the 0.1.0 milestone Oct 27, 2025
* note on recommendation about use SA versus exciting (default) kubeconfig
* adding a collapsible section
* removed incorrect args

Signed-off-by: Matthias Wessendorf <[email protected]>
@matzew
Copy link
Collaborator Author

matzew commented Oct 27, 2025

@manusa updated an rebased

Copy link
Collaborator

@Cali0707 Cali0707 left a comment

Choose a reason for hiding this comment

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

LGTM from my end

@manusa @matzew do we want to throw up a GH pages site around these markdown files?

Copy link
Member

@manusa manusa left a comment

Choose a reason for hiding this comment

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

LGTM, thx!

@manusa manusa merged commit 42a0674 into containers:main Oct 27, 2025
6 checks passed
@matzew
Copy link
Collaborator Author

matzew commented Oct 27, 2025

do we want to throw up a GH pages site around these markdown files?

yes, but that is separate steps. I was thinking about that too

@manusa
Copy link
Member

manusa commented Oct 27, 2025

LGTM from my end

@manusa @matzew do we want to throw up a GH pages site around these markdown files?

There's an old branch of mine (https://github.com/containers/kubernetes-mcp-server/tree/doc/docusaurus) from when this was still a personal PoC.

I think we should create some sort of website but discuss exactly how we want to do this (also considering the downstream implications).

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.

3 participants