obsidian-plugin/aaronsb_obsidian-mcp-plugin
1
0
Fork 0
mirror of https://github.com/aaronsb/obsidian-mcp-plugin.git synced 2026-07-22 06:45:14 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
aaronsb_obsidian-mcp-plugin/docs/PROJECT_STRUCTURE.md
Aaron Bockelie 36301118a9 docs: Add comprehensive project documentation and security audit 
- Add CONTRIBUTING.md with development guidelines
- Add SECURITY.md with vulnerability reporting policy
- Create GitHub issue templates for bugs and features
- Add PR template with checklist
- Set up GitHub Actions for testing and security scanning
- Document all security findings from code audit
- Create detailed GitHub issues for all vulnerabilities
- Update CHANGELOG with security audit results
- Add project structure documentation

This establishes proper open-source project structure and documents
all critical security issues that need to be addressed.

🤖 Generated with Claude Code

Co-Authored-By: Claude <noreply@anthropic.com>
2025-07-12 00:14:45 -05:00

2.8 KiB
Raw Blame History

Project Structure

obsidian-mcp-plugin/
├── .github/
│   ├── ISSUE_TEMPLATE/
│   │   ├── bug_report.md
│   │   └── feature_request.md
│   ├── workflows/
│   │   ├── test.yml          # CI/CD tests
│   │   └── security.yml      # Security scanning
│   └── pull_request_template.md
│
├── src/
│   ├── main.ts               # Plugin entry point
│   ├── mcp-server.ts         # MCP HTTP server
│   ├── semantic/             # Semantic operations
│   │   └── router.ts         # Operation routing
│   ├── tools/                # MCP tool implementations
│   ├── utils/                # Utility functions
│   │   ├── obsidian-api.ts   # Vault operations
│   │   ├── session-manager.ts # Session handling
│   │   └── connection-pool.ts # Connection management
│   └── types/                # TypeScript definitions
│
├── github-issues/            # Security audit findings
│   ├── 01-authentication-vulnerability.md
│   ├── 02-path-traversal-vulnerability.md
│   ├── 03-input-validation-missing.md
│   ├── 04-insecure-session-management.md
│   ├── 05-solid-principles-violations.md
│   ├── 06-large-vault-scalability.md
│   └── README.md
│
├── tests/                    # Test files
├── docs/                     # Documentation
│
├── .gitignore
├── CHANGELOG.md             # Version history
├── CONTRIBUTING.md          # Contribution guidelines
├── LICENSE                  # MIT License
├── README.md               # Main documentation
├── SECURITY.md             # Security policy
├── manifest.json           # Obsidian plugin manifest
├── package.json            # Node.js dependencies
├── tsconfig.json           # TypeScript config
└── versions.json           # Version compatibility

Key Directories

/src

Core plugin code. Main entry point is main.ts.

/src/semantic

Handles semantic routing for MCP operations. The router maps operations to actual implementations.

/src/utils

Shared utilities including the ObsidianAPI abstraction layer and session management.

/.github

GitHub-specific files including issue templates and automated workflows.

/github-issues

Detailed security audit findings ready to be posted as GitHub issues.

Configuration Files

  • manifest.json - Obsidian plugin metadata
  • package.json - Node dependencies and scripts
  • tsconfig.json - TypeScript compiler settings
  • versions.json - Obsidian version compatibility

Development Files

  • CLAUDE.md - Project-specific instructions for AI assistants
  • .claude/CLAUDE.md - User's global AI instructions