Context7

🚀 Context7 Project Introduction

Context7 is a project that provides useful tools and services. It simplifies the process of library ID resolution and library document retrieval, offering a convenient development experience for developers.

🚀 Quick Start

📦 Installation

You can install the project using npm:

npm install -g @upstash/context7-mcp

🌟 Start the Service

After installation, start the service with the following command:

context7-mcp start --port 3001

✨ Features

🔍 Tool Introduction

resolve-library-id

Resolve a generic library name to a Context7-compatible library ID.

• Parameter: libraryName (required)

get-library-docs

Retrieve library documentation using a Context7-compatible library ID.

• Parameters:
  • context7CompatibleLibraryID (required)
  • topic (optional): Focus on a specific topic, such as "routing" or "hooks".
  • tokens (optional, default 5000): The maximum number of tokens to return. If less than the configured DEFAULT_MINIMUM_TOKENS value, it will be automatically increased to that value.

📦 Installation Guide

📝 Example Configuration

Add the following content to your package.json:

{
  "mcpServers": {
    "context7": {
      "command": "npx",
      "args": ["-y", "@upstash/context7-mcp@latest"]
    }
  }
}

🏠 Local Configuration Example

{
  "mcpServers": {
    "context7": {
      "command": "npx",
      "args": ["tsx", "/path/to/folder/context7-mcp/src/index.ts"]
    }
  }
}

🌐 Environment Variable Configuration

Set the Default Port

export DEFAULT_PORT=3002

Configure the Log Level

export LOG_LEVEL=info

💻 Usage Examples

🔰 Basic Usage

const { Context7MCP } = require('@upstash/context7-mcp');

async function main() {
    const mcp = new Context7MCP();
    await mcp.start({ port: 3001 });
}

main().catch(console.error);

🚀 Advanced Usage

const config = {
    port: 3002,
    logLevel: 'debug',
    apiEndpoints: ['api.example.com', 'docs.example.com']
};

const { Context7MCP } = require('@upstash/context7-mcp');

async function main() {
    const mcp = new Context7MCP(config);
    await mcp.start();
}

main().catch(console.error);

📚 Documentation

🛠️ Development Guide

Clone the Project and Install Dependencies

bun i

Build the Project

bun run build

🧪 Test with MCP Inspector

npx -y @modelcontextprotocol/inspector npx @upstash/context7-mcp@latest

📋 Documentation Example

Steps to Solve Problems

1. Install dependencies: npm install @upstash/context7-mcp
2. Create a configuration file: context7-config.json
3. Start the service: npx context7-mcp start --port 3001

📝 Best Practices

• Always use the latest version for optimal performance and security updates.
• In a production environment, it is recommended to configure the port to a non-default value for improved security.
• Regularly check for document updates to keep your project knowledge up-to-date.

🔧 Technical Details

🐞 Problem Solving

Module Not Found Error

If you encounter this error, try using bunx instead of npx.

{
  "mcpServers": {
    "context7": {
      "command": "bunx",
      "args": ["-y", "@upstash/context7-mcp@latest"]
    }
  }
}

ESM Parsing Issue

If you encounter an error like Error: Cannot find module 'uriTemplate.js', try using the following command:

{
  "mcpServers": {
    "context7": {
      "command": "npx",
      "args": [
        "-y",
        "--node-options=--experimental-vm-modules",
        "@upstash/context7-mcp@1.0.6"
      ]
    }
  }
}

🚫 Client Error Handling

1. If an error occurs, try removing the @latest version number.
2. Try using bunx as an alternative.
3. Consider using deno as another option.
4. Ensure you are using Node.js v18 or higher for native fetch support in npx.

📄 License

This project is licensed under the MIT License. See LICENSE for details.

📞 Contact

For help or feedback, please visit the GitHub repository or contact email@example.com.

📰 Media Coverage

• [Better Stack]: "Free tool makes Cursor 10 times more powerful"
• [Cole Medin]: "Context7 is a new tool for developers"
• [Tech News]: "How Context7 simplifies document retrieval"