TypeScript Package Introspector (MCP Server) logo

TypeScript Package Introspector (MCP Server)

by t3ta

This tool introspects TypeScript packages and source code to extract exported symbols and their type information. It runs as a Model Context Protocol (MCP) server.

View on GitHub

Last updated: N/A

What is TypeScript Package Introspector (MCP Server)?

The TypeScript Package Introspector is an MCP server that provides detailed information about TypeScript packages and source code. It extracts exported symbols (functions, classes, types, constants) and their type information, making it useful for tools that need to understand TypeScript code.

How to use TypeScript Package Introspector (MCP Server)?

To use the server, start it with npx ts-introspect-mcp-server. Integrate it into your project by creating a .roo/mcp.json configuration file that defines the server command and arguments. You can then use the provided MCP tools like introspect-package and introspect-source to analyze packages and source code.

Key features of TypeScript Package Introspector (MCP Server)

  • Extract exported symbols from npm packages

  • Analyze TypeScript source code directly

  • Get detailed type signatures for all exported symbols

  • Extract JSDoc comments as descriptions

  • Provide type information to LLMs through MCP

Use cases of TypeScript Package Introspector (MCP Server)

  • Providing type information to LLMs for code understanding

  • Generating documentation for TypeScript packages

  • Analyzing dependencies and API surface of TypeScript libraries

  • Building tools that require deep understanding of TypeScript code

FAQ from TypeScript Package Introspector (MCP Server)

What is MCP?

MCP stands for Model Context Protocol. It is a protocol for communication between tools and services, often used in the context of LLMs.

How do I install the server?

You can run it directly using npx ts-introspect-mcp-server without a global installation.

What parameters does introspect-package take?

The introspect-package tool takes the packageName parameter, which is the name of the npm package to introspect.

What parameters does introspect-source take?

The introspect-source tool takes the source parameter, which is the TypeScript source code to analyze.

Is this project open source?

Yes, it is licensed under the MIT license.