-
Notifications
You must be signed in to change notification settings - Fork 15
Closed
Labels
ai-generateddocumentationImprovements or additions to documentationImprovements or additions to documentationrefactoringtask
Description
Objective
Update documentation files to reflect the new internal/auth package structure and authentication implementation after the refactoring is complete.
Context
After creating the internal/auth package, we should update relevant documentation to help developers understand:
- The centralized auth package location
- MCP spec 7.1 compliance for auth headers
- How to add new auth-related functionality
Approach
1. Update AGENTS.md
In the "Project Structure" section, add:
- `internal/auth/` - Authentication header parsing and middlewareIn the "Common Tasks" section, add:
**Add Auth Logic**: Implement in `internal/auth/` package 2. Update README.md (if auth is documented there)
- Add reference to
internal/authpackage - Document auth header format per MCP spec 7.1
- Clarify that plain API key format is required (no Bearer prefix)
3. Add package documentation
In internal/auth/header.go, ensure comprehensive package docs:
// Package auth provides authentication header parsing and middleware
// for the MCP Gateway server.
//
// This package implements MCP specification 7.1 for authentication,
// which requires Authorization headers to contain the API key directly
// without any scheme prefix (e.g., NOT "Bearer <key>").
//
// Example usage:
//
// apiKey, agentID, err := auth.ParseAuthHeader(r.Header.Get("Authorization"))
// if err != nil {
// // Handle error
// }
package auth4. Update any inline comments
- Review
server/auth.goandguard/context.gofor stale comments - Ensure comments reference the auth package where appropriate
Files to Modify
AGENTS.md(add auth package to structure)README.md(if applicable)internal/auth/header.go(add package documentation)internal/server/auth.go(update comments)internal/guard/context.go(update comments)
Acceptance Criteria
- AGENTS.md updated with auth package structure
- Package documentation added to auth/header.go
- MCP spec 7.1 compliance documented clearly
- All auth-related comments are accurate and up-to-date
- Documentation reviewed for consistency
- No broken links or references
Dependencies
- Requires: #aw_auth001 (auth package creation)
- Requires: #aw_auth002 (auth tests)
Priority
Low - Documentation update should follow implementation.
Estimated Effort
30 minutes - 1 hour
Related to #226
AI generated by Plan Command for #226
Reactions are currently unavailable
Metadata
Metadata
Labels
ai-generateddocumentationImprovements or additions to documentationImprovements or additions to documentationrefactoringtask
Type
Fields
Give feedbackNo fields configured for issues without a type.