LearnNewsExamplesServices
Frontmatter
id7401
titleDesign Knowledge Base MCP Server API
stateClosed
labels
enhancementhelp wantedgood first issuehacktoberfestai
assigneesChesblaw
createdAtOct 7, 2025, 12:05 PM
updatedAtOct 24, 2025, 11:26 AM
githubUrlhttps://github.com/neomjs/neo/issues/7401
authortobiu
commentsCount3
parentIssue7399
subIssues[]
subIssuesCompleted0
subIssuesTotal0
blockedBy[]
blocking[]
closedAtOct 24, 2025, 11:26 AM

Design Knowledge Base MCP Server API

Closed v11.0.0 enhancementhelp wantedgood first issuehacktoberfestai
tobiu
tobiu commented on Oct 7, 2025, 12:05 PM

This ticket covers the detailed API design for the new Knowledge Base MCP server. The server will replace the current npm run ai:query script, providing a formal, structured interface for agents to query the project's knowledge base.

This design must define a comprehensive, resource-oriented API for managing the documents and the database itself, ensuring consistency with the Memory Core MCP server.

Acceptance Criteria

  1. A clear, resource-oriented API endpoint structure is designed.
  2. The following endpoints are defined with their request and response contracts:
    • GET /docs: Serves interactive API documentation (Swagger UI).
    • GET /healthcheck: Confirms server health and DB connection.
    • GET /documents: Lists all documents in the knowledge base.
    • GET /documents/:id: Retrieves a specific document by its ID.
    • POST /documents/query: The primary search endpoint.
    • POST /db/sync: Triggers the delta update and synchronization process.
    • DELETE /db: Deletes the entire knowledge base collection.
  3. The API design is formally documented in an OpenAPI 3.0 specification file at buildScripts/mcp/knowledge/openapi.yaml.
  4. The design is documented in a new guide within the learn/guides/ai/ directory, ready for implementation.

Agent Instructions

To work on this ticket, please start your session with the following prompt:

Please follow the instructions in @AGENTS.md.

Once you are initialized, I want to work on a sub-task for the "Architect AI Tooling as a Model Context Protocol (MCP) Servers" epic.

My task is to implement: Design Knowledge Base MCP Server API

You will need to read the epic context from @.github/ISSUE/epic-architect-ai-tooling-as-mcp.md and the specific ticket details from @.github/ISSUE/ticket-design-knowledge-mcp-api.md before we begin.

tobiu added parent issue #7399 on Oct 7, 2025, 12:05 PM
tobiu added the enhancement label on Oct 7, 2025, 12:05 PM
tobiu added the help wanted label on Oct 7, 2025, 12:05 PM
tobiu added the good first issue label on Oct 7, 2025, 12:05 PM
tobiu added the hacktoberfest label on Oct 7, 2025, 12:05 PM
tobiu added the ai label on Oct 7, 2025, 12:05 PM
Chesblaw
Chesblaw Oct 8, 2025, 5:45 AM

@tobiu sup can you assign me

tobiu
tobiu Oct 8, 2025, 11:32 AM

Hi, and thanks for your interest. Sure, I can assign the ticket to you. Please look into the parent epic first, since it requires the new "AI Native" workflows: https://github.com/neomjs/neo/issues/7399

tobiu assigned to @Chesblaw on Oct 8, 2025, 11:32 AM
tobiu
tobiu Oct 24, 2025, 11:26 AM

Hi @Chesblaw,

Thank you for your interest in this ticket during Hacktoberfest.

As there has been no activity for a couple of weeks and the project's architecture has been evolving rapidly, the API for the Knowledge Base MCP server has now been designed and implemented.

We're closing this ticket now. Thanks again for your willingness to contribute, and we hope to see you in other issues!

tobiu closed this issue on Oct 24, 2025, 11:26 AM