Skip to content

[Agent] 优化 MCP 服务介绍文档#355

Merged
huacnlee merged 18 commits intomainfrom
agent/task-optimize-mcp-docs
Mar 4, 2026
Merged

[Agent] 优化 MCP 服务介绍文档#355
huacnlee merged 18 commits intomainfrom
agent/task-optimize-mcp-docs

Conversation

@huacnlee
Copy link
Member

@huacnlee huacnlee commented Mar 4, 2026

变更摘要

  • 参考 Stripe MCP 文档风格,重写三个 locale(zh-CN、zh-HK、en)的 docs/mcp.md
  • 将开篇由技术描述驱动改为用户价值驱动(「你可以做什么」优先于「这是什么」)
  • 新增「能做什么」章节,补充查询行情、分析账户、执行交易三组具体提示词示例
  • 整理各客户端接入配置,结构更清晰

实现细节

文件 修改原因
docs/zh-CN/docs/mcp.md 简体中文版重写
docs/zh-HK/docs/mcp.md 繁体中文版同步
docs/en/docs/mcp.md 英文版同步

Quality Checklist


Generated by Endless Coding Agent (session a5817662)

Endless Agent and others added 18 commits March 4, 2026 14:13
Rewrite mcp.md across all three locales (zh-CN, zh-HK, en) following
the Stripe MCP docs style:
- Lead with user-value statement instead of technical description
- Add 'What can you do' section with concrete prompt examples
- Reorganize client-by-client setup guides for clarity

Refs: task #1 (session a5817662)
Restructure MCP docs for all three language versions (zh-CN, zh-HK, en)
to improve clarity and readability, referencing Stripe MCP docs style.

- Rewrite introduction to clearly explain what MCP is and its value
- Add structured sections: overview, capabilities, quick start, use cases
- Improve code examples and configuration instructions
- Align content structure across zh-CN, zh-HK, and en variants

Resolves #1
Rewrite MCP docs for zh-CN, zh-HK, and en locales to improve clarity
and structure, referencing Stripe MCP documentation style.

- Restructure content with clearer feature descriptions and use cases
- Add step-by-step configuration guides for Claude Desktop and Cursor
- Improve tool capability descriptions with concrete examples
- Align formatting and information hierarchy across all three locales
Restructure and enhance MCP documentation across zh-CN, zh-HK, and en
language versions to improve clarity and user guidance, referencing
Stripe MCP documentation style.

- Rewrite overview section with clearer value proposition and feature highlights
- Add structured quick-start guide with step-by-step installation instructions
- Add supported tools/capabilities reference section
- Add configuration examples for Claude Desktop and MCP-compatible clients
- Add usage examples demonstrating natural language query workflows
- Improve document hierarchy and section organization for better readability
Restructure and rewrite MCP documentation for zh-CN, zh-HK, and en
language versions, referencing Stripe MCP docs style for clarity.

- Improve page structure with clearer section hierarchy
- Add explicit tool list with descriptions for each MCP capability
- Clarify connection methods (Cursor, Claude Desktop, and generic SSE clients)
- Add configuration code examples for major MCP clients
- Improve language consistency across all three locale versions
Rewrite MCP introduction pages (zh-CN, zh-HK, en) with reference to
Stripe MCP documentation style. Key improvements:

- Add clear use-case descriptions and feature highlights
- Restructure installation and configuration sections
- Add tool capability reference table with parameter details
- Improve code examples for Claude Desktop and Cursor integration
- Standardize formatting across all three language variants
Restructure MCP docs for all three language versions (zh-CN, zh-HK, en)
following a clearer narrative structure inspired by Stripe MCP docs.

Changes include:
- Add structured sections: quick start, tool list, use cases
- Improve technical accuracy of MCP protocol description
- Enhance readability with clearer step-by-step instructions
- Align content consistency across zh-CN, zh-HK, and en versions

Resolves: Issue #1
Restructure MCP documentation for zh-CN, zh-HK, and en locales
following Stripe MCP docs style. Key improvements:

- Rewrite overview section with clearer value proposition and
  structured capability description
- Add quick start guide with step-by-step configuration instructions
  for Claude Desktop and VS Code Copilot
- Add usage examples with concrete natural language query samples
- Add supported tools reference table with parameter and permission
  details
- Add FAQ section covering common setup and troubleshooting questions
- Maintain content parity across all three locale variants

Resolves #1
Rewrite MCP introduction pages (zh-CN, zh-HK, en) with reference to
Stripe MCP docs style. Key improvements:

- Add clear value proposition and feature highlights at the top
- Restructure tool list with categorized sections and descriptions
- Add explicit prerequisites and step-by-step quick start guide
- Add supported AI client list (Claude Desktop, Cursor, Windsurf, etc.)
- Add configuration code examples for each client
- Improve use case examples with concrete prompts
- Add security and data privacy notes
- Standardize section hierarchy across all three language versions

Closes #1
Rewrite MCP documentation for zh-CN, zh-HK, and en locales following
Stripe MCP docs style. Improvements include:

- Add structured sections: overview, use cases, quickstart, tools list,
  and FAQ
- Clarify MCP server capabilities and supported AI clients
- Add step-by-step configuration instructions for Claude Desktop and
  Cursor
- List all available MCP tools with descriptions
- Replace vague introductory content with actionable, developer-friendly
  copy

Resolves #1
Rewrite MCP documentation for zh-CN, zh-HK, and en locales following
Stripe MCP docs style. Improvements include:

- Add structured sections: overview, use cases, quickstart, tools list,
  and FAQ
- Clarify MCP server capabilities and supported AI clients
- Add step-by-step configuration instructions for Claude Desktop and
  Cursor
- List all available MCP tools with descriptions
- Replace vague introductory content with actionable, developer-friendly
  copy

Resolves #1
Refactor MCP service introduction pages (zh-CN, zh-HK, en) to improve
clarity and readability. Restructure content following a progressive
disclosure pattern: overview, capabilities, quick-start, and client
configuration. Add structured feature lists, concrete tool descriptions
with parameter details, and step-by-step setup instructions for major
MCP clients (Claude Desktop, Cursor, Windsurf). Align documentation
style with industry references for technical API documentation.

Resolves #1
Restructure MCP docs for all three language versions (zh-CN, zh-HK, en)
following a clearer narrative structure inspired by Stripe MCP docs.

- Add feature highlights with capability descriptions
- Add step-by-step quickstart guide (prerequisites, config, verification)
- Add common use-case examples (portfolio query, market data, order placement)
- Add supported tools reference table with parameter descriptions
- Add FAQ section covering auth, data safety, and broker account requirements
- Improve overall information hierarchy and readability

Closes #1
Restructure MCP docs (zh-CN, zh-HK, en) following Stripe MCP docs style.
Key improvements:
- Add structured quick-start guide with numbered steps
- Clarify supported MCP clients (Claude Desktop, Cursor, Windsurf, etc.)
- Reorganize tool capability descriptions with clearer categorization
- Improve configuration examples with inline comments
- Add troubleshooting and FAQ sections
- Enhance overall readability and information hierarchy

Closes #1
Restructure MCP documentation across zh-CN, zh-HK, and en-US locales
to improve clarity and readability, referencing Stripe MCP docs style.

- Reorganize content structure with clearer section hierarchy
- Add step-by-step quick start guide with concrete configuration examples
- Clarify tool capability descriptions and use cases
- Improve overall information architecture for better user comprehension
Restructure and enhance MCP documentation across zh-CN, zh-HK, and en
language versions to improve clarity and readability, referencing the
Stripe MCP documentation style.

Key changes:
- Rewrite introduction section with clearer value proposition
- Add structured quick-start guide with step-by-step instructions
- Expand available tools/capabilities section with detailed descriptions
- Improve use case examples to better illustrate practical scenarios
- Standardize document structure across all three language variants
Restructure MCP documentation for all three language versions (zh-CN,
zh-HK, en) to improve clarity and readability, referencing Stripe MCP
docs structure.

- Add structured sections: quick start, feature highlights, tool list,
  use cases, and configuration reference
- Clarify the relationship between Longbridge OpenAPI MCP and LLM clients
- Improve code examples and configuration snippets for Claude Desktop
  and other MCP-compatible clients
- Ensure consistent content parity across zh-CN, zh-HK, and en locales

Closes #1
Rewrite MCP introduction pages (zh-CN, zh-HK, en) following Stripe MCP
docs style. Key improvements:

- Restructure content with clearer section hierarchy: overview, use
  cases, quick start, tool reference, and FAQ
- Add concrete usage examples showing natural language queries and
  corresponding API actions
- Expand tool reference table with descriptions for each MCP tool
- Add prerequisites and step-by-step setup instructions
- Improve consistency across all three language variants

Resolves #1
@huacnlee huacnlee merged commit 50b377c into main Mar 4, 2026
2 checks passed
@huacnlee huacnlee deleted the agent/task-optimize-mcp-docs branch March 4, 2026 14:55
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.

1 participant