Skip to content
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

Add Smithery to README #399

Merged
merged 4 commits into from
Dec 23, 2024
Merged

Conversation

calclavia
Copy link
Contributor

@calclavia calclavia commented Dec 23, 2024

This PR makes two changes to the README.

  1. Adds installation instructions to automatically install Cognee for Claude Desktop using Smithery CLI. This makes it easier for users to install the MCP.
  2. Adds a badge to show the number of installations from Smithery: https://smithery.ai/server/cognee

Let me know if any tweaks have to be made!

Summary by CodeRabbit

  • New Features

    • Introduced automated installation instructions for the Cognee MCP server via Smithery.
  • Documentation

    • Enhanced README with a new section for automated installation, including a clear command for users.
    • Added a newline at the end of the README file to comply with coding standards.

Copy link
Contributor

coderabbitai bot commented Dec 23, 2024

Caution

Review failed

The pull request is closed.

Walkthrough

The pull request introduces documentation updates for the cognee project. The main README.md file has been modified to include a newline at the end for adherence to coding standards. Additionally, the cognee-mcp/README.md has been enhanced with new installation instructions, specifically adding an automated installation method via Smithery CLI for Claude Desktop users.

Changes

File Change Summary
README.md Added a newline at the end of the file
cognee-mcp/README.md Introduced a new "Installing via Smithery" section with CLI installation command

Possibly related PRs

  • Feat/cognee mcp #400: The changes in the README.md file for the cognee MCP server project include modifications to the setup instructions, which may relate to the overall documentation practices in the README.md file of the main PR.

Suggested reviewers

  • dexters1

Poem

🐰 A newline added, neat and fine,
In README.md, it’s all aligned!
With Smithery's guide, installation's a breeze,
Cognee hops forward, aiming to please!
Documentation shines, like stars that entwine! ✨


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 135613d and f2c3b21.

📒 Files selected for processing (2)
  • README.md (1 hunks)
  • cognee-mcp/README.md (1 hunks)

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@Vasilije1990
Copy link
Contributor

@calclavia please move the suggested installation instructions to the cognee-mcp folder README file

@calclavia calclavia changed the base branch from main to dev December 23, 2024 16:08
@calclavia
Copy link
Contributor Author

@calclavia please move the suggested installation instructions to the cognee-mcp folder README file

Done!

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (2)
cognee-mcp/README.md (2)

3-10: LGTM! Consider adding some helpful details.

The installation instructions are clear and well-formatted. To make it even more helpful for users, consider adding:

  • Prerequisites (e.g., Node.js version requirements)
  • Post-installation steps or verification instructions
🧰 Tools
🪛 Markdownlint (0.37.0)

3-3: Expected: h2; Actual: h3
Heading levels should only increment by one level at a time

(MD001, heading-increment)


3-3: Fix heading hierarchy

The heading level should only increment by one level at a time. Change the heading level from h3 to h2.

-### Installing via Smithery
+## Installing via Smithery
🧰 Tools
🪛 Markdownlint (0.37.0)

3-3: Expected: h2; Actual: h3
Heading levels should only increment by one level at a time

(MD001, heading-increment)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e770eda and efa2ecd.

📒 Files selected for processing (2)
  • README.md (1 hunks)
  • cognee-mcp/README.md (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • README.md
🧰 Additional context used
🪛 Markdownlint (0.37.0)
cognee-mcp/README.md

3-3: Expected: h2; Actual: h3
Heading levels should only increment by one level at a time

(MD001, heading-increment)

Vasilije1990
Vasilije1990 previously approved these changes Dec 23, 2024
@Vasilije1990 Vasilije1990 merged commit 730670c into topoteretes:dev Dec 23, 2024
1 check 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.

2 participants