Skip to content

docs: update README with MCP server and REST service sections #395

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

Merged
merged 1 commit into from
Apr 24, 2025

Conversation

danielchalef
Copy link
Member

@danielchalef danielchalef commented Apr 24, 2025

Important

README.md updated with new sections for MCP server and REST service, and minor formatting changes.

  • New Sections:
    • Added a tip about the MCP server in the introduction.
    • Introduced a new section for the REST service, detailing its purpose and linking to the server README.
  • Formatting:
    • Removed an extra line between badges and the Trendshift badge.

This description was created by Ellipsis for d0df237. You can customize this summary. It will automatically update as commits are pushed.

…section on Graph Service and added a new section for REST Service. Included a tip about the MCP server for enhanced user guidance.
@danielchalef danielchalef changed the title Update README.md to improve structure and clarity. Removed redundant section on Graph Service and added a new section for REST Service. Included a tip about the MCP server for enhanced user guidance. ... Apr 24, 2025
@danielchalef danielchalef marked this pull request as ready for review April 24, 2025 23:50
@ellipsis-dev ellipsis-dev bot changed the title ... docs: update README with MCP server and REST service sections Apr 24, 2025
@danielchalef danielchalef merged commit d11e34d into main Apr 24, 2025
6 checks passed
@getzep getzep locked and limited conversation to collaborators Apr 24, 2025
@danielchalef danielchalef deleted the chore/readme-imrpovement branch April 24, 2025 23:51
Copy link
Contributor

@ellipsis-dev ellipsis-dev bot left a comment

Choose a reason for hiding this comment

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

Important

Looks good to me! 👍

Reviewed everything up to d0df237 in 1 minute and 37 seconds. Click for details.
  • Reviewed 55 lines of code in 1 files
  • Skipped 0 files when reviewing.
  • Skipped posting 9 draft comments. View those below.
  • Modify your settings and rules to customize what types of comments Ellipsis leaves. And don't forget to react with 👍 or 👎 to teach Ellipsis.
1. README.md:24
  • Draft comment:
    Good use of the TIP admonition for highlighting the new MCP server. Ensure the relative link remains up to date as the project evolves.
  • Reason this comment was not posted:
    Confidence changes required: 0% <= threshold 80% None
2. README.md:164
  • Draft comment:
    The 'Graph Service' section was removed and later reintroduced as 'REST Service'. Consider adding a note or updating any related documentation for clarity if the service naming has changed.
  • Reason this comment was not posted:
    Confidence changes required: 50% <= threshold 80% None
3. README.md:23
  • Draft comment:
    Removal of an extraneous blank line improves visual consistency in the markdown layout.
  • Reason this comment was not posted:
    Confidence changes required: 0% <= threshold 80% None
4. README.md:23
  • Draft comment:
    New [!TIP] callout for the MCP server is a useful addition. Ensure its placement fits the document’s flow and that styling is consistent.
  • Reason this comment was not posted:
    Confidence changes required: 33% <= threshold 80% None
5. README.md:159
  • Draft comment:
    Removal of the 'Graph Service' section appears intentional. Confirm that no critical API info was lost as its content is now covered under the new 'REST Service' section.
  • Reason this comment was not posted:
    Confidence changes required: 66% <= threshold 80% None
6. README.md:180
  • Draft comment:
    The new 'REST Service' section clearly describes the FastAPI-based service. Ensure this naming aligns with internal references and user expectations.
  • Reason this comment was not posted:
    Confidence changes required: 66% <= threshold 80% None
7. README.md:190
  • Draft comment:
    Typographical error: Consider changing 'OpenAi-compatible' to 'OpenAI-compatible' to match the proper branding.
  • Reason this comment was not posted:
    Comment was on unchanged code.
8. README.md:192
  • Draft comment:
    Typographical error: The phrase 'such as Anthropic or Voyage models' may be a mistake. If these refer to supported models (e.g., Anthropic and Groq), please update 'Voyage' to the correct model name for consistency.
  • Reason this comment was not posted:
    Comment was not on a location in the diff, so it can't be submitted as a review comment.
9. README.md:259
  • Draft comment:
    Typographical error: The command 'uv add "graphiti-core[google-genai]"' appears to be a mistake. Verify if 'uv' is intended or if it should be replaced with the correct package manager command (e.g., 'poetry add').
  • Reason this comment was not posted:
    Comment was not on a location in the diff, so it can't be submitted as a review comment.

Workflow ID: wflow_BJ0268l9oaeSmmdG

You can customize Ellipsis by changing your verbosity settings, reacting with 👍 or 👎, replying to comments, or adding code review rules.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant