Skip to content

Commit 17f128c

Browse files
committed
feat: Add class diagram for core AgentStack agents and tools
- Introduced a new section in the README for the class diagram. - Documented the structure and relationships of core agents and tools including: - Agent - Tool - codingTeamNetwork - codingA2ACoordinator - codeArchitectAgent - codeReviewerAgent - testEngineerAgent - refactoringAgent - Various coding tools (codeAnalysisTool, codeSearchTool, etc.)
1 parent 8ae74ee commit 17f128c

1 file changed

Lines changed: 144 additions & 0 deletions

File tree

README.md

Lines changed: 144 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -379,3 +379,147 @@ npm run mcp-server
379379
📘 **[Docs](https://agentstack.ai)** (Coming Q1 2026)
380380

381381
_Last updated: 2025-12-05 | v3.3.0_
382+
383+
## 📚 **Class Diagram**
384+
385+
- Latest class diagram for core AgentStack agents and tools:
386+
387+
```mermaid
388+
classDiagram
389+
class Agent {
390+
+string id
391+
+string name
392+
+string description
393+
+function instructions(runtimeContext)
394+
+model
395+
+memory
396+
+tools
397+
+agents
398+
+workflows
399+
+scorers
400+
+maxRetries
401+
}
402+
403+
class Tool {
404+
+string id
405+
+string description
406+
+inputSchema
407+
+outputSchema
408+
+function execute(context)
409+
}
410+
411+
class codingTeamNetwork {
412+
+id = "coding-team-network"
413+
+name = "Coding Team Network"
414+
+description
415+
+agents: coding_agents
416+
}
417+
418+
class codingA2ACoordinator {
419+
+id = "codingA2ACoordinator"
420+
+name = "Coding A2A Coordinator"
421+
+description
422+
+agents: coding_agents
423+
}
424+
425+
class codeArchitectAgent {
426+
+id = "code-architect"
427+
+name = "Code Architect Agent"
428+
+description
429+
+UserTier userTier
430+
+string language
431+
+string projectRoot
432+
}
433+
434+
class codeReviewerAgent {
435+
+id = "code-reviewer"
436+
+name = "Code Reviewer Agent"
437+
+description
438+
}
439+
440+
class testEngineerAgent {
441+
+id = "test-engineer"
442+
+name = "Test Engineer Agent"
443+
+description
444+
}
445+
446+
class refactoringAgent {
447+
+id = "refactoring"
448+
+name = "Refactoring Agent"
449+
+description
450+
}
451+
452+
class codeAnalysisTool {
453+
+id = "coding:codeAnalysis"
454+
+description
455+
+CodeAnalysisInput inputSchema
456+
+CodeAnalysisOutput outputSchema
457+
}
458+
459+
class codeSearchTool {
460+
+id = "coding:codeSearch"
461+
+description
462+
+CodeSearchInput inputSchema
463+
+CodeSearchOutput outputSchema
464+
}
465+
466+
class diffReviewTool {
467+
+id = "coding:diffReview"
468+
+description
469+
+DiffReviewInput inputSchema
470+
+DiffReviewOutput outputSchema
471+
}
472+
473+
class multiStringEditTool {
474+
+id = "coding:multiStringEdit"
475+
+description
476+
+MultiStringEditInput inputSchema
477+
+MultiStringEditOutput outputSchema
478+
}
479+
480+
class testGeneratorTool {
481+
+id = "coding:testGenerator"
482+
+description
483+
+TestGeneratorInput inputSchema
484+
+TestGeneratorOutput outputSchema
485+
}
486+
487+
Agent <|-- codingTeamNetwork
488+
Agent <|-- codingA2ACoordinator
489+
Agent <|-- codeArchitectAgent
490+
Agent <|-- codeReviewerAgent
491+
Agent <|-- testEngineerAgent
492+
Agent <|-- refactoringAgent
493+
494+
Tool <|-- codeAnalysisTool
495+
Tool <|-- codeSearchTool
496+
Tool <|-- diffReviewTool
497+
Tool <|-- multiStringEditTool
498+
Tool <|-- testGeneratorTool
499+
500+
codingTeamNetwork o-- codeArchitectAgent
501+
codingTeamNetwork o-- codeReviewerAgent
502+
codingTeamNetwork o-- testEngineerAgent
503+
codingTeamNetwork o-- refactoringAgent
504+
505+
codingA2ACoordinator o-- codeArchitectAgent
506+
codingA2ACoordinator o-- codeReviewerAgent
507+
codingA2ACoordinator o-- testEngineerAgent
508+
codingA2ACoordinator o-- refactoringAgent
509+
510+
codeArchitectAgent --> codeAnalysisTool
511+
codeArchitectAgent --> codeSearchTool
512+
513+
codeReviewerAgent --> codeAnalysisTool
514+
codeReviewerAgent --> diffReviewTool
515+
codeReviewerAgent --> codeSearchTool
516+
517+
testEngineerAgent --> codeAnalysisTool
518+
testEngineerAgent --> testGeneratorTool
519+
testEngineerAgent --> codeSearchTool
520+
521+
refactoringAgent --> multiStringEditTool
522+
refactoringAgent --> codeAnalysisTool
523+
refactoringAgent --> diffReviewTool
524+
refactoringAgent --> codeSearchTool
525+
```

0 commit comments

Comments
 (0)