Tools

extract_endpoints

Extract and document REST API endpoints from web frameworks

The extract_endpoints tool scans your codebase for REST API endpoint definitions and extracts them into structured documentation. It supports multiple web frameworks and can export to OpenAPI or Postman formats for API documentation and testing.

How It Works

Stellarion uses regex pattern matching optimized for each supported framework to detect route definitions. It extracts HTTP methods, paths, handlers, parameters, and middleware. The framework is auto-detected from your project configuration, or you can specify it explicitly.

When to Use

Documenting API endpoints: Create an inventory of all endpoints
Generating API specifications: Export to OpenAPI for documentation tools
Creating Postman collections: Generate ready-to-use API test collections
Understanding API structure: Get an overview of your API surface
API auditing: Review all exposed endpoints for security or completeness

Parameters

Parameter	Type	Required	Default	Description
`path`	string	No	`.`	Directory to scan
`framework`	string	No	`auto`	`auto`, `express`, `fastapi`, `spring`, `django`, `flask`, or `rails`
`outputFormat`	string	No	`json`	`json`, `openapi`, or `postman`
`groupBy`	string	No	-	Group by `method`, `path`, or `resource`
`pathPrefix`	string	No	-	Filter endpoints by path prefix
`includeParameters`	boolean	No	false	Extract route parameters
`includeHandlers`	boolean	No	false	Include handler function names
`includeMiddleware`	boolean	No	false	Include middleware chain
`includeAuth`	boolean	No	false	Include authentication requirements
`includeStatistics`	boolean	No	false	Include endpoint statistics

MCP Command Syntax

mcp__stellarion__extract_endpoints framework:express outputFormat:openapi includeParameters:true

Supported Frameworks

Framework	Detection Patterns
Express	`app.get()`, `router.get()`, `app.post()`, etc.
FastAPI	`@app.get()`, `@router.get()`, `@app.post()`, etc.
Spring	`@GetMapping`, `@PostMapping`, `@RequestMapping`, etc.
Django	URL patterns, class-based views, `path()`, `re_path()`
Flask	`@app.route()`, blueprints, `@blueprint.route()`
Rails	`routes.rb` definitions, `resources`, `get`, `post`, etc.

Examples

Basic Extraction

Natural Language:

Extract all API endpoints from this project

Direct MCP Call:

mcp__stellarion__extract_endpoints

Returns: List of all detected endpoints with methods and paths

Express Endpoints

Natural Language:

Find all Express routes in the api directory

Direct MCP Call:

mcp__stellarion__extract_endpoints framework:express path:src/api/

With Parameters and Handlers

Natural Language:

Extract endpoints and show their route parameters and handler functions

Direct MCP Call:

mcp__stellarion__extract_endpoints includeParameters:true includeHandlers:true

Generate OpenAPI Specification

Natural Language:

Generate an OpenAPI specification from my API endpoints

Direct MCP Call:

mcp__stellarion__extract_endpoints outputFormat:openapi includeParameters:true

Returns: OpenAPI 3.0 specification document

Create Postman Collection

Natural Language:

Create a Postman collection for testing my API

Direct MCP Call:

mcp__stellarion__extract_endpoints outputFormat:postman includeParameters:true

Returns: Postman Collection v2.1.0 ready for import

Group by Resource

Natural Language:

Show me endpoints grouped by resource (users, products, orders, etc.)

Direct MCP Call:

mcp__stellarion__extract_endpoints groupBy:resource includeStatistics:true

Filter by Path Prefix

Natural Language:

Extract only the API endpoints (paths starting with /api)

Direct MCP Call:

mcp__stellarion__extract_endpoints pathPrefix:/api includeStatistics:true

Include Authentication Info

Natural Language:

Show me all endpoints with their authentication requirements

Direct MCP Call:

mcp__stellarion__extract_endpoints includeAuth:true includeMiddleware:true

FastAPI Endpoints

Natural Language:

Extract all FastAPI endpoints with their parameters

Direct MCP Call:

mcp__stellarion__extract_endpoints framework:fastapi includeParameters:true includeHandlers:true

Output Formats

JSON (Default)

Standard JSON with endpoint details:

{
  "endpoints": [
    {
      "method": "GET",
      "path": "/api/users/:id",
      "handler": "getUser",
      "file": "src/routes/users.ts",
      "line": 45,
      "parameters": [
        { "name": "id", "type": "path", "required": true }
      ]
    }
  ],
  "statistics": {
    "total": 24,
    "byMethod": { "GET": 12, "POST": 6, "PUT": 4, "DELETE": 2 }
  }
}

OpenAPI 3.0

Complete OpenAPI specification compatible with Swagger UI, Redoc, and other documentation tools:

openapi: 3.0.0
info:
  title: API Documentation
  version: 1.0.0
paths:
  /api/users/{id}:
    get:
      operationId: getUser
      parameters:
        - name: id
          in: path
          required: true

Postman Collection v2.1.0

Ready-to-import Postman collection:

{
  "info": {
    "name": "API Collection",
    "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
  },
  "item": [...]
}

Output Details

Each endpoint includes:

Field	Description
HTTP method	GET, POST, PUT, DELETE, PATCH
Path pattern	Route path with parameters
Handler function	Name of the handler (when enabled)
File location	Source file path
Line number	Where the route is defined
Route parameters	Path and query parameters (when enabled)
Middleware	Middleware chain (when enabled)
Authentication	Auth requirements (when enabled)

Statistics

When includeStatistics: true:

Metric	Description
Total count	Number of endpoints
By method	Breakdown by HTTP method
By prefix	Endpoints grouped by path prefix
Coverage	Files scanned vs. files with routes

Grouping Options

Group By	Description
`method`	Group by HTTP method (GET, POST, etc.)
`path`	Group by path prefix (/api/users, /api/products)
`resource`	Group by extracted resource name (users, products)

Tips for Best Results

Use framework: "auto" for automatic detection - usually works well
Filter with pathPrefix: "/api" to focus on API routes only
Use outputFormat: "openapi" for documentation tools
Use outputFormat: "postman" for API testing
Include includeParameters: true for complete endpoint information

Common Workflows

API Documentation

# Extract endpoints with full details
mcp__stellarion__extract_endpoints outputFormat:openapi includeParameters:true includeHandlers:true

# Save the OpenAPI spec for documentation tools

Security Audit

# List all endpoints with auth info
mcp__stellarion__extract_endpoints includeAuth:true includeMiddleware:true groupBy:path

# Review which endpoints are protected

API Testing Setup

# Generate Postman collection
mcp__stellarion__extract_endpoints outputFormat:postman includeParameters:true

# Import into Postman for testing

Edit this pageorReport an issue

find_refactoring

Identify refactoring opportunities with priority and effort estimates

batch_analyze

High-performance bulk file analysis with parallel processing