Hypermodel

Overview

Context is everything for coding agents.

Make your coding agents better with the right documentation, auto-updated for you and in context, all the time.

Auto-install in one command

npx -y -p @hypermodel/cli add-docs claude

Usage with an AI coding agent like Claude Code or Amp

Use @hypermodel/docs MCP server with your favourite AI coding agent

Common Usage Patterns

Examples:

1. can you call search the docs on how to use "contact" objects ?

2. Explain amp.tools.stopTimeout and its default in the docs of ampcode. use docs tool

Quick Start Flow

1. Link to your scope (optional): Use link tool to associate with a user or team. Default scope is 'user'.
2. Check available docs: Use list-docs to see what documentation is available in your current scope.
3. Search documentation: Use search-docs with the index name, your query, and optional result count.
4. Create new indices (if needed): Use index tool to index a new documentation source if not already present.

Tip: Use the base documentation URL (https://supabase.com/docs) instead of an inner link (https://supabase.com/docs/guides/functions/dependencies)

Scope and Access Management

Scope Types

• user (default): Personal documentation access
• team: Shared team documentation access

Linking Workflow

1. Link to a user: link tool with user identifier
2. Link to a team: link tool with team identifier and scope='team'
3. Once linked, all list-docs, search-docs, and index operations work within that scope
4. Each user has access to docs based on their permissions and scope context

Embedding Provider Configuration

The system supports both OpenAI and Google Gemini for generating embeddings. By default, it uses OpenAI, but you can configure it to use Gemini instead.

Environment Variables

Variable	Description	Default Value
EMBEDDING_PROVIDER	Choose embedding provider: openai or gemini	openai
OPENAI_API_KEY	OpenAI API key (required when using OpenAI)	-
OPENAI_EMBEDDING_MODEL	OpenAI embedding model	text-embedding-3-small
OPENAI_EMBEDDING_DIMENSIONS	OpenAI embedding dimensions	512
GEMINI_API_KEY	Google Gemini API key (required when using Gemini)	-
GEMINI_EMBEDDING_MODEL	Gemini embedding model	gemini-embedding-001
GEMINI_EMBEDDING_DIMENSIONS	Gemini embedding dimensions	768

Examples

To use OpenAI (default):

export OPENAI_API_KEY="your-openai-key"
# EMBEDDING_PROVIDER defaults to 'openai'

To use Google Gemini:

export EMBEDDING_PROVIDER="gemini"
export GEMINI_API_KEY="your-gemini-key"

Note: When switching embedding providers, ensure that existing vector stores are compatible with the new embedding dimensions, or re-index your documentation with the new provider.

Tools exposed for your coding agents

Tool	Description	Output / Result
link	Link to a user or team to set your scope context	Links your session to a user/team for scoped documentation access
list-docs	Check what documentation is available in your current scope	{ "indexes": ["ampcode-com", "developer-salesforce-com"] }
search-docs	Search documentation for answers in your current scope	Returns ranked results with URLs, titles, snippets, and relevance scores
index	Add a new documentation source if not already present	Creates searchable index from the documentation site
index-status	Check detailed status and progress of indexing jobs	Real-time progress, duration, error details for indexing workflows
list-indexing-jobs	List recent indexing jobs for your current scope	History of indexing jobs with status, progress, and timing info

Tips for Best Results

• Use natural language queries with the terms search docs anywhere in your prompt for the MCP tool to be used.
• Start with broader queries, then narrow down based on results
• Results include relevance scores to help identify the most useful content

All IDEs supported

• Cursor (cursor)
  • Example:

    npx -y -p @hypermodel/cli add-docs cursor

• Vscode (vscode)
  • Example:

    npx -y -p @hypermodel/cli add-docs vscode

• Ampcode (amp)
  • Example:

    npx -y -p @hypermodel/cli add-docs amp

Don't see your IDE?

• Request support by opening a GitHub issue: Request support for another IDE
• Or go to the issues page: https://github.com/hypermodel-labs/docs/issues

Contributing

Looking to contribute? All kinds of help is highly appreciated.

Checkout our contribution guide for more.