Skip to content

Add setup for claude code#29

Merged
msafarik merged 1 commit into
mainfrom
edit_documentation
May 20, 2026
Merged

Add setup for claude code#29
msafarik merged 1 commit into
mainfrom
edit_documentation

Conversation

@msafarik

@msafarik msafarik commented May 20, 2026

Copy link
Copy Markdown
Collaborator

Summary by Sourcery

Document Claude Code setup and update client configuration guidance for the Keylime MCP server and web client.

Documentation:

  • Mention that the project provides both an MCP server and a privacy-focused web client for Keylime remote attestation.
  • Add setup instructions for using the MCP server with Claude Code and clarify the optional env configuration and default certificate path for other MCP clients.

@msafarik msafarik self-assigned this May 20, 2026
@sourcery-ai

sourcery-ai Bot commented May 20, 2026

Copy link
Copy Markdown
Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Update README to describe both the MCP server and new privacy-focused web client, and clarify configuration instructions for using the server with Claude Code and other MCP clients, including default certificate paths and optional environment configuration.

Flow diagram for configuring Keylime MCP with Claude Code and Claude Desktop

flowchart TD
    A[Install and build Keylime MCP server<br/>make build-server] --> B{Which MCP client?}

    B --> C[Claude Code]
    B --> D[Claude Desktop or other MCP client]

    C --> C1[Run<br/>claude mcp add keylime --scope user /full/path/to/keylime-mcp/bin/server]
    C1 --> E[Server uses default cert path<br/>/var/lib/keylime/cv_ca]

    D --> D1[Edit<br/>~/.config/Claude/claude_desktop_config.json]
    D1 --> D2[Add mcpServers.keylime entry<br/>with command and args]
    D2 --> E

    E --> F[Optionally configure env block<br/>for non-default cert paths]
    F --> G[Ensure certs readable<br/>make setup-certs]
Loading

File-Level Changes

Change Details Files
Document use of the project as both an MCP server and a privacy-focused web client.
  • Update the project description to mention the privacy-focused web client in addition to the MCP server
README.md
Clarify setup instructions for Claude-based MCP clients, including Claude Code CLI and Claude Desktop.
  • Add explicit setup command for registering the MCP server with Claude Code via the CLI
  • Retitle and clarify the JSON configuration example as applicable to Claude Desktop and other MCP clients
  • Explain that the env block in the MCP configuration is optional due to sensible server defaults
  • Clarify that certificate files live under /var/lib/keylime/cv_ca by default and that read permissions are required, referencing the make setup-certs helper
README.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@coderabbitai

coderabbitai Bot commented May 20, 2026

Copy link
Copy Markdown

Important

Review skipped

Review was skipped due to path filters

⛔ Files ignored due to path filters (1)
  • README.md is excluded by !**/*.md

CodeRabbit blocks several paths by default. You can override this behavior by explicitly including those paths in the path filters. For example, including **/dist/** will override the default block on the dist directory, by removing the pattern from both the lists.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: db11d8c3-568c-4b44-bfb5-577c5861f368

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch edit_documentation

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Hey - I've left some high level feedback:

  • In the Claude Code section, consider explicitly tying the claude mcp add command to the build step (e.g., noting that /full/path/to/keylime-mcp/bin/server refers to the binary produced by make build-server) to avoid ambiguity about which path to use.
  • You might want to clarify that the JSON config snippet applies only to config-file–driven MCP clients (like Claude Desktop) and is not needed when using the claude mcp add CLI, to help users choose the correct setup path.
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- In the Claude Code section, consider explicitly tying the `claude mcp add` command to the build step (e.g., noting that `/full/path/to/keylime-mcp/bin/server` refers to the binary produced by `make build-server`) to avoid ambiguity about which path to use.
- You might want to clarify that the JSON config snippet applies only to config-file–driven MCP clients (like Claude Desktop) and is not needed when using the `claude mcp add` CLI, to help users choose the correct setup path.

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Signed-off-by: Marek Safarik <msafarik@redhat.com>
@msafarik
msafarik force-pushed the edit_documentation branch from b978328 to bb1ed44 Compare May 20, 2026 12:05
@msafarik
msafarik merged commit ef9936f into main May 20, 2026
7 checks passed
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.

1 participant