LearnNewsExamplesServices
Frontmatter
titleDesign Memory Core MCP Server API
authorMannXo
stateMerged
createdAtOct 8, 2025, 5:15 PM
updatedAtOct 8, 2025, 5:36 PM
closedAtOct 8, 2025, 5:35 PM
mergedAtOct 8, 2025, 5:35 PM
branchesdev ← feature/design-memory-mcp-api
urlhttps://github.com/neomjs/neo/pull/7419
Merged
MannXo
MannXo commented on Oct 8, 2025, 5:15 PM
  • Create OpenAPI 3.0 specification with all 11 required endpoints
  • Add comprehensive API documentation guide
  • Update navigation tree
  • Resolves #7402

Please make sure to read the Contributing Guidelines:

https://github.com/neomjs/neo/blob/dev/CONTRIBUTING.md

What kind of change does this PR introduce? (check at least one)

  • Bugfix
  • Feature
  • Code style update
  • Refactor
  • Build-related changes
  • Other, please describe:

Does this PR introduce a breaking change? (check one)

  • Yes
  • No

If yes, please describe the impact and migration path for existing applications:

The PR fulfills these requirements:

  • It's submitted to the dev branch, not the main branch
  • When resolving a specific issue, it's referenced in the PR's title (e.g. fix #xxx[,#xxx], where "xxx" is the issue number)

If adding a new feature, the PR's description includes:

  • A convincing reason for adding this feature (to avoid wasting your time, it's best to open a suggestion issue first and wait for approval before working on it)

Other information:

tobiu
tobiu commented on Oct 8, 2025, 5:35 PM

Excellent and thanks, greatly appreciated. Here is the Gemini feedback:

✦ This is an absolutely outstanding pull request. The contributor has gone above and beyond to deliver a comprehensive and professional API design.

Here is my review based on the ticket's acceptance criteria:

  1. API Structure: Excellent. The API is cleanly designed with a resource-oriented structure (/memories, /summaries, /db), which is exactly what the ticket asked for. The use of tags in the OpenAPI spec is also very well done.

  2. Endpoint Definitions: Complete. All required endpoints from the ticket have been defined in both the OpenAPI spec and the markdown guide. The request and response contracts are incredibly detailed, including schemas, examples, and error responses.

  3. OpenAPI Specification: Perfect. The openapi.yaml file is a textbook example of a great API specification. It's thorough, well-documented, and will be invaluable for generating client libraries or for the team that implements the server.

  4. Markdown Guide: Exceptional. The MemoryCoreMcpApi.md guide is fantastic. It not only documents the API but also explains the architecture, data models, and provides clear migration paths from the old CLI scripts with curl examples. This is incredibly helpful.

Bonus Points:

  • The contributor proactively updated learn/tree.json to ensure the new guide is immediately visible in the learning portal. This shows great attention to detail.

The file path buildScripts/mcp/memory/ is based on the ticket before we made our recent architectural decision. This is not an issue with this PR, as we have already updated the subsequent implementation tickets to use the new ai/mcp/server/ path. The design work itself is perfect.

This PR is a 10/10. It's a prime example of a high-quality contribution and should be merged as is.

tobiu
tobiu commented on Oct 8, 2025, 5:36 PM

off topic hint: https://github.com/neomjs/neo/issues/7399#issuecomment-3382081813 => definitely worth an exploration imho.