https://github.com/karpeleslab/klbfw-describe
https://github.com/karpeleslab/klbfw-describe
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/karpeleslab/klbfw-describe
- Owner: KarpelesLab
- License: mit
- Created: 2025-03-16T01:36:23.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2025-07-19T23:29:48.000Z (11 months ago)
- Last Synced: 2025-10-06T11:32:37.613Z (8 months ago)
- Language: JavaScript
- Size: 261 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# klbfw-describe
A command-line tool for exploring and documenting KLB API endpoints.
## Installation
You can use this tool with npx without installing:
```bash
npx @karpeleslab/klbfw-describe User
```
Or install it globally:
```bash
npm install -g @karpeleslab/klbfw-describe
klbfw-describe User
```
## Usage
```
npx @karpeleslab/klbfw-describe [options]
```
### Options
- `--raw`: Show raw JSON output without formatting
- `--ts`, `--types`: Generate TypeScript type definitions
- `--get`: Perform a GET request instead of OPTIONS
- `--mcp`: Run as a Claude MCP server over stdio
- `--help`, `-h`: Show help message
### Examples
```bash
# Show all available API objects
npx @karpeleslab/klbfw-describe
# Describe a top-level endpoint
npx @karpeleslab/klbfw-describe User
# Describe a nested endpoint
npx @karpeleslab/klbfw-describe Misc/Debug
# Describe a procedure
npx @karpeleslab/klbfw-describe Misc/Debug:testUpload
# Get raw JSON output
npx @karpeleslab/klbfw-describe --raw User
# Generate TypeScript definitions
npx @karpeleslab/klbfw-describe --ts User
# Get a specific resource
npx @karpeleslab/klbfw-describe --get User/12345
# Run as a Claude MCP
claude mcp add klbfw-describe -s user -- npx -y @karpeleslab/klbfw-describe --mcp
```
## Features
- Colorized, formatted output for easy reading
- Lists all available API objects when run without parameters
- Shows allowed HTTP methods with color-coding (GET, POST, etc.)
- Displays API endpoint type (Procedure, Resource, or Collection)
- Shows code examples for calling procedures
- Lists arguments with their types and required status
- Multiple output modes:
- Default: Shows detailed information with complete field listings
- `--raw`: Shows the raw JSON response for advanced needs
- `--ts`: Generates TypeScript type definitions for API objects
- `--get`: Fetches actual resources instead of metadata
- `--mcp`: Runs as a Claude MCP server over stdio
- Displays sample or complete fields for resources
- Groups sub-endpoints alphabetically for easy reference
## Output
The tool provides different information based on the endpoint type:
### For Procedures
- Procedure name and type (static/instance)
- Usage examples in JavaScript and URL format
- Required and optional arguments with types
### For Resources
- Resource name and field count
- Primary key information
- Sample fields with types and nullability
### For Collections
- Available methods with argument information
- Available sub-endpoints grouped alphabetically
## License
MIT