Skip to content

docs: add LLM-friendly documentation and generation script #788

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

askdevai-bot
Copy link

This PR adds comprehensive LLM-friendly documentation to help developers effectively use the MCP TypeScript SDK with AI assistants and LLM-based development tools.

Changes

  • LLM.md: Complete API documentation optimized for LLM consumption

    • Detailed overview of the MCP TypeScript SDK
    • Complete API reference with usage examples
    • Integration patterns and best practices
    • Type definitions and interfaces
    • Error handling and troubleshooting
  • generate-llm-docs.ts: Automated documentation generation script

    • Uses TypeScript AST parsing to extract API information
    • Generates structured documentation from source code
    • Supports future updates and maintenance
  • package.json: Added dev dependencies for documentation generation

    • Added TypeScript compiler support for doc generation

Benefits

  • Enhanced Developer Experience: AI assistants can now provide accurate, context-aware help
  • Reduced Onboarding Time: New developers can quickly understand the SDK through AI guidance
  • Improved Accuracy: LLMs can provide precise code examples and usage patterns
  • Future-Proof: Automated generation ensures docs stay current with code changes

Testing

  • Verified documentation generation script works correctly
  • Confirmed all links and references are accurate
  • Tested with various LLM models for accuracy

Contribution Guidelines Compliance

  • Follows existing code style and conventions
  • Includes comprehensive documentation
  • Provides clear examples and usage patterns
  • Maintains backward compatibility

This documentation enhancement aligns with the project's goal of making MCP more accessible to developers using modern AI-assisted development workflows.

A developer on Askdev.AI requested this update

- Add comprehensive LLM.md file with complete API documentation
- Include generate-llm-docs.ts script for automated documentation generation
- Update package.json with necessary dependencies for doc generation
- Provide detailed usage examples and integration patterns for LLM consumption

This documentation enables developers to effectively use the MCP TypeScript SDK
with AI assistants and LLM-based development tools.
@askdevai-bot askdevai-bot requested review from a team and ihrpr July 19, 2025 23:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant