uapi-client
v0.3.9
Published
CLI client for Library Navigator API with MCP integration
Downloads
48
Maintainers
Readme
UAPI
A command-line interface for the Library Navigator API, allowing you to browse and search documentation libraries directly from your terminal.
Installation
npm install -g uapi-clientOr use it directly with npx:
npx uapi-clientUsage
Check API Status
uapi statusList Available Documentation Domains
uapi listNavigate a Directory
uapi nav /modal.comWith search suggestions:
uapi nav /modal.com -q installationView a File
uapi view /modal.com/README.mdSearch for Files
uapi search "deployment"With library and result count:
uapi search "deployment" -l modal.com -k 10Configure the API URL
uapi config -u https://your-api-url.comMCP Integration
To integrate this client with the MCP desktop app, add the following to your app's server configuration:
{
"mcpServers": {
"libraryNavigator": {
"command": "npx",
"args": [
"-y",
"uapi-client"
]
}
}
}Cursor Integration (MCP)
You can integrate UAPI Client directly with Cursor using the Multi-Client Protocol (MCP). This allows you to run UAPI commands directly from Cursor.
Setup
- Copy the provided
mcp-config.jsonto~/.cursor/mcp.json(or merge it with your existing MCP configuration):
{
"mcpServers": {
"uapi-client-mcp": {
"command": "npx",
"args": ["-y", "uapi-client@latest", "uapi-mcp"]
}
}
}Restart Cursor or reload the MCP configuration
Access the UAPI Client from Cursor by typing
/uapifollowed by any of the available commands
Available Commands in Cursor
/uapi status- Check API server status/uapi list- Lists all available documentation domains (websites) that have been crawled and are accessible through the MCP server. This tool shows you the complete catalog of documentation sources available./uapi nav <path> [query]- Allows you to browse through a documentation domain's structure, seeing what files are available within. You can provide an optional query parameter to receive contextually relevant file suggestions./uapi view <file_path>- Retrieves and displays the full content of a specific documentation file by its virtual path. This lets you read the actual documentation text without leaving your conversation./uapi search <query> [library] [topk]- Performs a semantic vector search across documentation to find content relevant to your query. You can search across all documentation domains or limit to a specific one, and specify how many results to return./uapi config [url]- Set or view API base URL
Use Cases
List Domains
When starting a new project and wanting to know what documentation resources are available to you.
"I need to see what documentation libraries are available."
> Lists 40+ domains including docs.anthropic.com, api.slack.com, modal.com, etc.
"Great, now I know I can access documentation for Anthropic APIs as I build my AI assistant."Navigate Directory
When exploring a specific API's documentation structure to find relevant guides or references.
"Show me what's available in the Anthropic documentation."
> Navigates to /docs.anthropic.com and displays all files including mcp.md, extended-thinking.md, models.md, etc.
"I see there's documentation about MCP itself, let me look at that file specifically."View File
When you need detailed information about a specific feature or API from the documentation.
"Show me the contents of the Anthropic MCP documentation."
> Displays the complete content of /docs.anthropic.com/mcp.md, explaining MCP as "an open protocol that standardizes how applications provide context to LLMs," along with links and implementation details.
"Now I understand how the Model Context Protocol works and how I can implement it in my application."Search Files
When you need to find specific information but don't know which file contains it.
"Search across all documentation for information about API authentication methods."
> Returns semantically relevant results from multiple domains, showing different approaches to API authentication across various services.
"Perfect, now I can compare different authentication approaches and choose the most appropriate one for my project."These MCP tools together provide a comprehensive way to access and utilize external documentation without breaking context in your conversation, making it much more effective for technical tasks that require reference to specific API details or implementation patterns.
Development
# Clone the repository
git clone <repository-url>
cd uapi-client
# Install dependencies
npm install
# Build the package
npm run build
# Run locally
node dist/index.js
# Watch for changes during development
npm run watchLicense
MIT
