Tsdoc Jsdoc Authoring
Automatically generates comprehensive documentation (TsDoc & JSDoc) from your code, streamlining developer workflows and improving project maintainability.
Install on your platform
We auto-selected Claude Code based on this skill’s supported platforms.
Run in terminal (recommended)
claude mcp add tsdoc-jsdoc-authoring npx -- -y @trustedskills/tsdoc-jsdoc-authoring
Or manually add to ~/.claude/settings.json
{
"mcpServers": {
"tsdoc-jsdoc-authoring": {
"command": "npx",
"args": [
"-y",
"@trustedskills/tsdoc-jsdoc-authoring"
]
}
}
}Requires Claude Code (claude CLI). Run claude --version to verify your install.
About This Skill
What it does
This skill allows AI agents to generate JSDoc comments for TypeScript code. It understands existing code and produces structured documentation blocks, improving code maintainability and developer understanding. The generated documentation adheres to the JSDoc standard, making it compatible with various documentation generators.
When to use it
- Automating Documentation: Generate initial JSDoc stubs for a new TypeScript project or codebase.
- Refactoring Existing Code: Quickly add missing JSDoc comments during code refactoring efforts.
- Improving Code Readability: Create clear and concise documentation directly within the source code, enhancing understanding for other developers (or yourself later!).
- Generating API Documentation: Produce a foundation for automated API documentation generation tools.
Key capabilities
- Generates JSDoc comments
- Supports TypeScript code
- Adheres to JSDoc standard
- Understands existing code context
Example prompts
- "Generate JSDoc for this function:
function calculateSum(a, b) { return a + b; }" - "Add JSDoc comments to all functions in this file."
- “Create JSDoc documentation explaining the purpose of this class.”
Tips & gotchas
The skill requires access to the TypeScript code you want documented. Ensure the AI agent has appropriate permissions and context to analyze the codebase effectively.
Tags
TrustedSkills Verification
Unlike other registries that point to live repositories, TrustedSkills pins every skill to a verified commit hash. This protects you from malicious updates — what you install today is exactly what was reviewed and verified.
Security Audits
| Gen Agent Trust Hub | Pass |
| Socket | Pass |
| Snyk | Pass |
🌐 Community
Passed automated security scans.