Skip to content

Created detailed architecture markdown to share design aspects #597

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Created detailed architecture markdown to share design aspects #597

wants to merge 2 commits into from

Conversation

ernest-chen
Copy link

Description

Created ARCHITECTURE.md to help developers understand the overall structure and design of mcp-go

Type of Change

  • Bug fix (non-breaking change that fixes an issue)
  • New feature (non-breaking change that adds functionality)
  • MCP spec compatibility implementation
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update
  • Code refactoring (no functional changes)
  • Performance improvement
  • Tests only (no functional changes)
  • Other (please describe):

Checklist

  • My code follows the code style of this project
  • I have performed a self-review of my own code
  • I have added tests that prove my fix is effective or that my feature works
  • I have updated the documentation accordingly

MCP Spec Compliance

  • This PR implements a feature defined in the MCP specification
  • Link to relevant spec section: Link text
  • Implementation follows the specification exactly

Additional Information

This is my first time contributing, please provide more detailed feedback whenever possible.

@ernest-chen
Add comprehensive architecture documentation
cd8f6d3 
- Add detailed ARCHITECTURE.md with complete system overview
- Include Mermaid diagrams for visual architecture representation
- Document core components: Client, Server, MCP Core packages
- Cover transport layer implementations (Stdio, HTTP, SSE, In-Process)
- Explain session management and multi-client support
- Detail protocol implementation and request processing pipeline
- Document design patterns: Strategy, Observer, Middleware, Factory
- Include extension points for customization
- Add security considerations and performance optimizations
- Provide testing strategy overview
- Comprehensive technical reference for developers and contributors
@ernest-chen
Merge branch 'mark3labs:main' into main
f0e391a
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@ernest-chen