matimo 0.1.0-alpha.2 → 0.1.0-alpha.3

package/docs/getting-started/installation.md

@@ -1,124 +0,0 @@
-# Installation & Setup
-
-## Requirements
-
-- **Node.js**: v18.0.0 or higher
-- **pnpm**: v8.15.0 or higher (preferred package manager)
-- **Git**: For cloning the repository
-
-## Installation Options
-
-### Option 1: From npm (Recommended for Users)
-
-```bash
-npm install matimo
-# or with pnpm (recommended)
-pnpm add matimo
-```
-
-**Note**: v0.1.0-alpha.1 is available on npm. Stable v1.0.0 release coming in Q4 2026.
-
-### Option 2: From Source (Recommended for Contributors)
-
-```bash
-# Clone the repository
-git clone https://github.com/tallclub/matimo.git
-cd matimo
-
-# Install dependencies
-pnpm install
-
-# Build TypeScript
-pnpm build
-
-# Run tests to verify installation
-pnpm test
-```
-
-## Verify Installation
-
-```typescript
-// test-install.ts
-import { matimo } from 'matimo';
-
-const instance = await matimo.init('./tools');
-console.log(`✅ Matimo installed successfully`);
-console.log(`📦 Loaded ${instance.listTools().length} tools`);
-```
-
-Run it:
-
-```bash
-npx tsx test-install.ts
-```
-
-## Next Steps
-
-- **New Users**: Go to [Quick Start](./QUICK_START.md)
-- **Want Examples**: See [examples/](../../examples/)
-- **Building Tools**: Read [Tool Specification](../tool-development/YAML_TOOLS.md)
-- **Using Decorators**: Check [Decorator Guide](../tool-development/DECORATOR_GUIDE.md)
-
-## Troubleshooting Installation
-
-### Node.js Version Error
-
-```bash
-node --version  # Should be v18.0.0 or higher
-```
-
-If lower, install Node.js 18+ from [nodejs.org](https://nodejs.org/)
-
-### pnpm Installation
-
-```bash
-npm install -g pnpm@8.15.0
-pnpm --version  # Should be 8.15.0 or higher
-```
-
-### Build Errors
-
-```bash
-# Clear and rebuild
-pnpm clean
-pnpm install
-pnpm build
-```
-
-If issues persist, check [Troubleshooting Guide](../troubleshooting/FAQ.md)
-
-## System Requirements
-
-| Component | Requirement |
-|-----------|------------|
-| Node.js | ≥ 18.0.0 |
-| pnpm | ≥ 8.15.0 |
-| TypeScript | ≥ 5.0 (included) |
-| Disk Space | ~500MB (with node_modules) |
-| Memory | ≥ 512MB for build |
-
-## IDE Setup
-
-### VS Code (Recommended)
-
-```bash
-# Extensions to install
-- ES7+ React/Redux/React-Native snippets
-- Prettier - Code formatter
-- ESLint
-- Thunder Client (for testing HTTP tools)
-```
-
-### WebStorm / IntelliJ
-
-Works out of the box with TypeScript support.
-
-## Quick Verification Checklist
-
-- [ ] Node.js v18+ installed
-- [ ] pnpm v8.15+ installed
-- [ ] Repository cloned
-- [ ] `pnpm install` completed
-- [ ] `pnpm build` successful
-- [ ] `pnpm test` all passing
-- [ ] Ready to start! 🚀

package/docs/index.md

@@ -1,289 +0,0 @@
-# Matimo Documentation
-<p align="center">
-<img src="./assets/logo.png" alt="Matimo Logo" width="120" style="border-radius: 8px; margin: 20px 0;" />
-</p>
-
-**Matimo** (Maximum AI Tools in Modular Objects) — Define tools once in YAML, use them everywhere.
-
-> Built to solve the universal tool orchestration problem for AI agents.
-
-Complete documentation for Matimo.
-
-## Getting Started
-
-- **[Quick Start](./getting-started/QUICK_START.md)** — Get up and running in 5 minutes
-  - Installation with npm/pnpm
-  - Load tools from directory
-  - Execute tools with SDK
-  - Use MCP Server
-  - Common tasks and examples
-
-## Reference
-
-- **[API Reference](./api-reference/SDK.md)** — Complete TypeScript SDK documentation
-  - MatimoFactory for creating instances
-  - ToolLoader for loading tools
-  - ToolRegistry for managing tools
-  - CommandExecutor and HttpExecutor
-  - Error handling and error codes
-  - Complete type definitions
-
-- **[Architecture Overview](./architecture/OVERVIEW.md)** — System design and patterns
-  - High-level architecture
-  - Framework integration patterns (3 approaches)
-  - Pure SDK vs Framework integration
-  - Data flow diagrams
-
-- **[Tool Specification](./tool-development/TOOL_SPECIFICATION.md)** — How to write YAML tools
-  - Tool metadata (name, version, description)
-  - Parameter types and validation
-  - Execution types (command, HTTP, script)
-  - Output schema definition
-  - Authentication configuration
-  - Error handling and retry logic
-  - Complete YAML examples
-
-- **[Decorator Guide](./tool-development/DECORATOR_GUIDE.md)** — Using @tool TypeScript decorators
-  - @tool and @param decorators
-  - Type-safe tool definitions
-  - Async tool execution
-  - Error handling in decorators
-  - Testing decorator tools
-  - Migration from YAML to decorators
-
-- **[Framework Integrations](./framework-integrations/LANGCHAIN.md)** — LangChain & CrewAI patterns
-  - LangChain Agent integration
-  - Decorator pattern with frameworks
-  - CrewAI tool composition
-  - Custom AI framework integration
-
-## Security
-
-- **[Security Guide](../SECURITY.md)** — Security standards and best practices
-  - Core security principles
-  - Secret management (environment variables)
-  - Input validation with schemas
-  - Error handling without leaking information
-  - Logging without sensitive data
-  - Authentication mechanisms
-  - Command execution safety
-  - Common vulnerabilities and fixes
-  - Security checklist
-  - Responsible vulnerability disclosure
-
-## Development
-
-- **[Commit Guidelines](./community/COMMIT_GUIDELINES.md)** — Conventional commits standard
-  - Commit format and components
-  - Type, scope, and subject guidelines
-  - Commit examples (feat, fix, docs, etc.)
-  - Best practices and common mistakes
-  - Git workflow and aliases
-
-- **[Development Standards](./user-guide/DEVELOPMENT_STANDARDS.md)** — Code quality rules
-  - TypeScript strict mode requirements
-  - Naming conventions (classes, functions, constants)
-  - Error handling patterns
-  - Testing standards and coverage targets
-  - Documentation and JSDoc standards
-  - Security standards (validation, secrets, escaping)
-  - Logging with structured information
-  - Performance and memory targets
-  - Quality metrics and checklists
-
-- **[Contributing Guidelines](../CONTRIBUTING.md)** — How to contribute to Matimo
-  - Getting started and setup
-  - Code standards and best practices
-  - Testing with TDD approach
-  - Commit and PR requirements
-  - Adding new tools
-  - Performance and quality targets
-  - Roadmap and current focus
-
----
-
-## Quick Navigation
-
-### For First-Time Users
-1. Start with [Quick Start](./getting-started/QUICK_START.md) for setup
-2. Check [API Reference](./api-reference/SDK.md) for SDK usage
-3. See [Tool Specification](./tool-development/TOOL_SPECIFICATION.md) to write tools
-4. Review [Architecture Overview](./architecture/OVERVIEW.md) to understand design
-
-### For Tool Writers
-1. Read [Tool Specification](./tool-development/TOOL_SPECIFICATION.md) for YAML tools
-2. Or use [Decorator Guide](./tool-development/DECORATOR_GUIDE.md) for TypeScript tools
-3. Follow [Development Standards](./user-guide/DEVELOPMENT_STANDARDS.md) for code quality
-
-### For Framework Integration
-1. Check [Framework Integrations](./framework-integrations/LANGCHAIN.md) for LangChain/CrewAI
-2. See [Architecture Overview](./architecture/OVERVIEW.md) for integration patterns
-3. Review examples in `examples/` directory
-
-### For Contributors
-1. Check [Contributing Guidelines](../CONTRIBUTING.md) for contribution guidelines
-2. Follow [Development Standards](./user-guide/DEVELOPMENT_STANDARDS.md) for code quality
-3. Use [Commit Guidelines](./community/COMMIT_GUIDELINES.md) for proper commit format
-
-### For Maintainers
-1. Review [Development Standards](./user-guide/DEVELOPMENT_STANDARDS.md) for quality metrics
-2. Check [Commit Guidelines](./community/COMMIT_GUIDELINES.md) for PR commit validation
-3. See [Contributing Guidelines](../CONTRIBUTING.md) for overall workflow
-
----
-
-## Documentation Structure
-
-```
-docs/
-├── index.md                      # This file - documentation index
-├── RELEASES.md                   # Release notes and changelog
-├── ROADMAP.md                    # Project roadmap
-├── getting-started/
-│   ├── QUICK_START.md            # 5-minute setup guide
-│   ├── installation.md           # Detailed installation instructions
-│   └── YOUR_FIRST_TOOL.md        # Create your first tool
-├── api-reference/
-│   ├── SDK.md                    # Complete SDK API
-│   ├── ERRORS.md                 # Error handling and error codes
-│   └── TYPES.md                  # TypeScript type definitions
-├── tool-development/
-│   ├── TOOL_SPECIFICATION.md     # YAML tool schema
-│   ├── DECORATOR_GUIDE.md        # TypeScript decorators
-│   ├── TESTING.md                # Testing tools
-│   ├── PROVIDER_CONFIGURATION.md # Multi-provider setup
-│   └── OAUTH_LINK.md             # OAuth authentication
-├── framework-integrations/
-│   └── LANGCHAIN.md              # LangChain & framework patterns
-├── architecture/
-│   └── OVERVIEW.md               # System design and patterns
-├── user-guide/
-│   ├── SDK_PATTERNS.md           # SDK usage patterns
-│   ├── TOOL_DISCOVERY.md         # Discovering tools
-│   ├── AUTHENTICATION.md         # Authentication setup
-│   └── DEVELOPMENT_STANDARDS.md  # Code quality rules
-├── community/
-│   └── COMMIT_GUIDELINES.md      # Conventional commits
-└── troubleshooting/
-    └── FAQ.md                    # Common questions & solutions
-
-Root-level files:
-├── ../CONTRIBUTING.md            # Contribution guidelines
-├── ../SECURITY.md                # Security policy
-└── ../README.md                  # Project overview
-```
-
----
-
-## Key Concepts
-
-### Tools
-Tools are the building blocks of Matimo. They define what can be executed, what parameters they accept, and how they run.
-
-- **YAML Tools** — Declarative tool definitions (see [Tool Specification](./TOOL_SPECIFICATION.md))
-- **Decorator Tools** — TypeScript-based tool definitions (see [Decorator Guide](./DECORATOR_GUIDE.md))
-
-### Executors
-Executors run tools with different backends:
-- **CommandExecutor** — Execute shell commands
-- **HttpExecutor** — Make HTTP requests
-
-See [API Reference](./API_REFERENCE.md) for details.
-
-### SDK
-Use the Matimo SDK (TypeScript) to load and execute tools:
-
-```typescript
-import { MatimoFactory } from 'matimo';
-
-const matimo = MatimoFactory.create({ toolsPath: './tools' });
-const result = await matimo.executeTool('tool-name', { param: 'value' });
-```
-
-See [Quick Start](./getting-started/QUICK_START.md) and [API Reference](./api-reference/SDK.md).
-
-### MCP Server
-Matimo can run as an MCP server, allowing Claude and other clients to discover and use tools:
-
-```typescript
-// MCP Server - Coming in Phase 2
-// import { MCPServer } from 'matimo/mcp';
-
-const server = new MCPServer({ toolsPath: './tools', port: 3000 });
-await server.start();
-```
-
-See [Quick Start](./getting-started/QUICK_START.md) for setup.
-
----
-
-## Standards & Practices
-
-### Code Quality
-- **TypeScript**: Strict mode enforced (no `any`)
-- **Testing**: 80%+ coverage, TDD approach
-- **Linting**: ESLint with automatic formatting
-- **Documentation**: JSDoc comments for all public APIs
-
-See [Development Standards](./DEVELOPMENT_STANDARDS.md).
-
-### Commits
-- **Format**: Conventional Commits (type(scope): subject)
-- **Types**: feat, fix, docs, refactor, test, chore, perf, style, ci
-- **Examples**: "feat(executor): add HTTP support", "fix(schema): validate enums"
-
-See [Commit Guidelines](./community/COMMIT_GUIDELINES.md).
-
-### Pull Requests
-- Follow TDD approach (test first, implement after)
-- Keep PRs focused (one feature/fix per PR)
-- Ensure tests pass and coverage maintained (80%+)
-- Follow code standards and get code review
-
-See [Contributing Guidelines](../CONTRIBUTING.md).
-
----
-
-## Common Tasks
-
-### Write a YAML Tool
-1. Create `tools/provider/tool-name.yaml`
-2. Follow [Tool Specification](./tool-development/TOOL_SPECIFICATION.md) schema
-3. Include parameters, execution, output_schema
-4. Add authentication if needed
-5. Test with `pnpm test`
-
-### Write a Decorator Tool
-1. Create `src/tools/tool-name.tool.ts`
-2. Use @tool and @param decorators
-3. Implement execute() or async execute()
-4. Follow [Decorator Guide](./tool-development/DECORATOR_GUIDE.md) patterns
-5. Add unit tests
-
-### Integrate with LangChain
-1. See [Framework Integrations](./framework-integrations/LANGCHAIN.md) for patterns
-2. Check `examples/langchain/` for working examples
-3. Follow [Architecture Overview](./architecture/OVERVIEW.md) for design decisions
-
-### Contribute Code
-1. Fork and clone repository
-2. Create feature branch: `git checkout -b feat/description`
-3. Write tests first (TDD)
-4. Implement feature
-5. Follow [Development Standards](./user-guide/DEVELOPMENT_STANDARDS.md)
-6. Commit using [Commit Guidelines](./community/COMMIT_GUIDELINES.md)
-7. Push and create PR
-8. Follow [Contributing Guidelines](../CONTRIBUTING.md) checklist
-
----
-
-## Need Help?
-
-- **Questions?** Check relevant documentation or open a [GitHub Discussion](https://github.com/tallclub/matimo/discussions)
-- **Found a bug?** [Open an issue](https://github.com/tallclub/matimo/issues)
-- **Troubleshooting?** See [FAQ](./troubleshooting/FAQ.md)
-- **Want to contribute?** See [Contributing Guidelines](../CONTRIBUTING.md)
-
----
-
-Last updated: February 2026