Skip to content

RAGFlow is an agent-native database: a Retrieval-Augmented Generation (RAG) engine that grew into context infrastructure.

chore(server): document missing CLI and MCP options (#19900)

Sbaaoui Idriss2e2c05e52c28
diff --git a/cmd/ragflow_server.go b/cmd/ragflow_server.go
index 105571e70c..d4f551eb18 100644
--- a/cmd/ragflow_server.go
+++ b/cmd/ragflow_server.go
@@ -404,11 +404,24 @@ func printHelp(args *serverArgs) {
fmt.Fprintf(os.Stderr, "Standalone action (mutually exclusive with a mode):\n")
fmt.Fprintf(os.Stderr, " --migrate \tRun database migrations and exit\n\n")
fmt.Fprintf(os.Stderr, "Common options:\n")
- fmt.Fprintf(os.Stderr, " --config string\tPath to configuration file\n")
+ fmt.Fprintf(os.Stderr, " -f, --config string\tPath to configuration file\n")
+ fmt.Fprintf(os.Stderr, " -p, --port int \tServer port (overrides config file)\n")
+ fmt.Fprintf(os.Stderr, " --admin-host string\tAdmin server host:port (ingestor and syncer)\n")
+ fmt.Fprintf(os.Stderr, " --name string \tServer name (ingestor and syncer)\n")
+ fmt.Fprintf(os.Stderr, " --init-superuser\tInitialize superuser account (admin)\n")
fmt.Fprintf(os.Stderr, " -v, --version \tPrint version information and exit\n")
fmt.Fprintf(os.Stderr, " --debug \tEnable debug-level logging\n")
- fmt.Fprintf(os.Stderr, " --profile \t\tEnable pprof server\n")
+ fmt.Fprintf(os.Stderr, " --profile \tEnable pprof server\n")
fmt.Fprintf(os.Stderr, " -h, --help \tShow this help message and exit\n\n")
+ fmt.Fprintf(os.Stderr, "API MCP options:\n")
+ fmt.Fprintf(os.Stderr, " --enable-mcpserver\tEnable the MCP server\n")
+ fmt.Fprintf(os.Stderr, " --mcp-host=string\tMCP bind address (default: 127.0.0.1)\n")
+ fmt.Fprintf(os.Stderr, " --mcp-port=int \tMCP port (default: 9382)\n")
+ fmt.Fprintf(os.Stderr, " --mcp-mode=self-host|host\tMCP mode (default: self-host)\n")
+ fmt.Fprintf(os.Stderr, " --mcp-host-api-key=string\tAPI key required in self-host mode\n")
+ fmt.Fprintf(os.Stderr, " --transport-sse-enabled, --no-transport-sse-enabled\tEnable or disable MCP SSE transport (default: enabled)\n")
+ fmt.Fprintf(os.Stderr, " --transport-streamable-http-enabled, --no-transport-streamable-http-enabled\tEnable or disable MCP streamable HTTP transport (default: enabled)\n")
+ fmt.Fprintf(os.Stderr, " --json-response, --no-json-response\tEnable or disable MCP JSON responses (default: enabled)\n\n")
fmt.Fprintf(os.Stderr, "Run '%s --api --help' for API server options.\n", os.Args[0])
fmt.Fprintf(os.Stderr, "Run '%s --admin --help' for admin server options.\n", os.Args[0])
fmt.Fprintf(os.Stderr, "Run '%s --ingestor --help' for ingester options.\n", os.Args[0])
@@ -423,6 +436,15 @@ func printHelp(args *serverArgs) {
fmt.Fprintf(os.Stderr, " --debug \tEnable debug-level logging\n")
fmt.Fprintf(os.Stderr, " --profile \t\tEnable pprof server\n")
fmt.Fprintf(os.Stderr, " -h, --help \tShow this help message and exit\n")
+ fmt.Fprintf(os.Stderr, "\nMCP options:\n")
+ fmt.Fprintf(os.Stderr, " --enable-mcpserver\tEnable the MCP server\n")
+ fmt.Fprintf(os.Stderr, " --mcp-host=string\tMCP bind address (default: 127.0.0.1)\n")
+ fmt.Fprintf(os.Stderr, " --mcp-port=int \tMCP port (default: 9382)\n")
+ fmt.Fprintf(os.Stderr, " --mcp-mode=self-host|host\tMCP mode (default: self-host)\n")
+ fmt.Fprintf(os.Stderr, " --mcp-host-api-key=string\tAPI key required in self-host mode\n")
+ fmt.Fprintf(os.Stderr, " --transport-sse-enabled, --no-transport-sse-enabled\tEnable or disable MCP SSE transport (default: enabled)\n")
+ fmt.Fprintf(os.Stderr, " --transport-streamable-http-enabled, --no-transport-streamable-http-enabled\tEnable or disable MCP streamable HTTP transport (default: enabled)\n")
+ fmt.Fprintf(os.Stderr, " --json-response, --no-json-response\tEnable or disable MCP JSON responses (default: enabled)\n")
case *args.mode == "admin":
fmt.Fprintf(os.Stderr, "Usage: %s --admin [OPTIONS]\n\n", os.Args[0])
fmt.Fprintf(os.Stderr, "RAGFlow Admin Server\n\n")