-
Notifications
You must be signed in to change notification settings - Fork 966
chore: update mcp readme #913
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
Conversation
Please make sure all the checkboxes are checked:
|
WalkthroughThe README.md for the cognee MCP server was updated to include a link to external documentation and a new "Running the Server" section. This section provides explicit instructions for starting the server using both stdio and SSE transport modes, detailing the specific commands to use for each. Changes
Possibly related PRs
Suggested reviewers
Poem
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. 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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this 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)
76-76: Remove trailing colon in heading
MarkdownLint (MD026) flags trailing punctuation in headings. Consider changing### Standard stdio transport:to### Standard stdio transport.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
76-76: Trailing punctuation in heading
Punctuation: ':'(MD026, no-trailing-punctuation)
81-81: Remove trailing colon in heading
MarkdownLint (MD026) flags trailing punctuation in headings. Consider changing### SSE transport:to### SSE transport.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
81-81: Trailing punctuation in heading
Punctuation: ':'(MD026, no-trailing-punctuation)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
cognee-mcp/README.md(2 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
cognee-mcp/README.md
76-76: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
81-81: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
⏰ Context from checks skipped due to timeout of 90000ms (10)
- GitHub Check: End-to-End Tests / S3 Bucket Test
- GitHub Check: End-to-End Tests / Deletion Test
- GitHub Check: End-to-End Tests / Deduplication Test
- GitHub Check: End-to-End Tests / Run Telemetry Test
- GitHub Check: End-to-End Tests / Run Telemetry Pipeline Test
- GitHub Check: End-to-End Tests / Server Start Test
- GitHub Check: Basic Tests / Run Simple Examples
- GitHub Check: Basic Tests / Run Basic Graph Tests
- GitHub Check: Basic Tests / Run Integration Tests
- GitHub Check: Basic Tests / Run Unit Tests
🔇 Additional comments (4)
cognee-mcp/README.md (4)
3-3: Add reference to external documentation
Good inclusion of a direct link to the MCP deployment guide for users needing more details.
74-74: Introduce "Running the Server" section
Clear separation of runtime instructions helps users get started quickly.
78-78: Include code block command
Command is clear and correctly formatted in a bash code block.
83-83: Include SSE transport command
Instruction is concise and correctly formatted; this covers the alternate transport mode.
Description
DCO Affirmation
I affirm that all code in every commit of this pull request conforms to the terms of the Topoteretes Developer Certificate of Origin.