Skip to content

docs: add MCP service guide and update README - #398

Open
RerankerGuo wants to merge 1 commit into
agentscope-ai:mainfrom
RerankerGuo:docs/issue-357-mcp-service-guide
Open

docs: add MCP service guide and update README#398
RerankerGuo wants to merge 1 commit into
agentscope-ai:mainfrom
RerankerGuo:docs/issue-357-mcp-service-guide

Conversation

@RerankerGuo

Copy link
Copy Markdown
Contributor

Summary

This PR addresses #357 by adding comprehensive MCP service documentation and updating the README.

Changes

New File: docs/en/mcp_service.md

A complete MCP service guide covering:

  • Overview: Transport types (stdio, SSE, streamable-http) and architecture
  • Quick Start: Commands to start MCP service with each transport
  • Configuration: YAML examples for transport selection, injected parameters
  • Tool Reference: Complete tables for all MCP-exposed tools organized by category:
    • File Operations (write, read, edit, delete, move, list, stat, frontmatter)
    • Search and Retrieval (search, node_search, traverse)
    • Memory Management (auto_memory, auto_resource, auto_dream, proactive, daily_list)
    • Indexing (reindex, bm25_search, vector_search)
  • Agent Integration: Setup guides for Claude Code, Codex, and generic MCP clients
  • Response Format: Explanation of string-based answer format for LLM consumers
  • Troubleshooting: Common issues and solutions

Modified: README.md

  • Added link to the new MCP Service Guide in the Agent Integration section

Rationale

The MCP service is a core integration path for ReMe (as highlighted in the README and existing plugin infrastructure). A dedicated, comprehensive guide helps:

  • New users understand how to expose ReMe as an MCP service
  • Agent developers integrate ReMe memory into their frameworks
  • Document the complete tool surface available to MCP consumers

Testing

  • Documentation-only change, no code modifications
  • Verified all tool names and parameters match current implementation
  • Verified configuration keys match reme/config/default.yaml
  • Cross-referenced existing plugin documentation

Checklist

  • Documentation follows existing style and structure
  • All tool names and parameters match current codebase
  • Configuration examples use valid YAML syntax
  • Cross-references to existing documentation are correct
  • README link was added in the appropriate section

Closes agentscope-ai#357
- Add docs/en/mcp_service.md with comprehensive MCP service documentation:
  - Overview of transports (stdio, SSE, streamable-http)
  - Quick start commands for each transport
  - Configuration reference with YAML examples
  - Complete tool reference tables (file ops, search, memory, indexing)
  - Agent integration examples (Claude Code, Codex, generic MCP)
  - Response format explanation for LLM consumers
  - Troubleshooting section
- Update README.md to link to the new MCP service guide

Test: documentation-only change, no code changes
@gemini-code-assist

Copy link
Copy Markdown
Contributor

Caution

The consumer version of Gemini Code Assist on GitHub has been sunset. All code review activity has officially ceased.

@CLAassistant

Copy link
Copy Markdown

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.


bytedance seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account.
You have signed the CLA already but the status is still pending? Let us recheck it.

@jinliyl
jinliyl requested a review from ployts July 29, 2026 02:21
@RerankerGuo
RerankerGuo force-pushed the docs/issue-357-mcp-service-guide branch from e9f259f to 9d85a04 Compare July 30, 2026 00:54
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