OpenSEO Documentation: Where to Find and Access the Complete Guide

You can find the official OpenSEO documentation in the docs/ directory of the every-app/open-seo repository, with the README serving as the primary navigation hub that links to setup guides, API configuration, and MCP agent integration.

The OpenSEO documentation is self-contained within the repository and structured to support both self-hosted deployments and local development. According to the source code, the documentation spans markdown guides in the docs/ folder and inline code documentation throughout src/lib/ and src/serverFunctions/.

Primary Documentation Entry Points

The documentation follows a hub-and-spoke model where the main README directs you to specialized guides based on your use case.

README.md – The Central Documentation Hub

The main README.md serves as the primary entry point, containing links to all subsidiary documentation. As shown in lines 39-44, it indexes critical resources including the MCP setup, Agent Skills configuration, and DataForSEO API integration. This file provides the architectural overview and prerequisites before you dive into implementation-specific guides.

Self-Hosting Documentation

OpenSEO offers two distinct self-hosting pathways, each with dedicated documentation:

Docker Deployment (docs/SELF_HOSTING_DOCKER.md)

• Located at docs/SELF_HOSTING_DOCKER.md (lines 1-10)
• Contains environment configuration steps
• Includes docker compose orchestration instructions
• References the .env.example file for required variables

Cloudflare Workers Deployment (docs/SELF_HOSTING_CLOUDFLARE.md)

• Located at docs/SELF_HOSTING_CLOUDFLARE.md (lines 1-10)
• Covers serverless deployment patterns
• Explains Wrangler configuration and edge deployment

Development and Integration Guides

Local Development (docs/LOCAL_DEVELOPMENT.md) The local development guide at docs/LOCAL_DEVELOPMENT.md (lines 1-10) documents the pnpm-based workflow, testing procedures, and development server startup. This is essential for contributors extending the MCP server or adding custom agent skills.

DataForSEO API Configuration (docs/DATAFORSEO_API_KEY.md) Located at docs/DATAFORSEO_API_KEY.md (lines 1-10), this guide explains how to obtain and configure the required API key for SEO data retrieval. This is a prerequisite for both self-hosted and local development environments.

MCP and Agent Skills (docs/mcp/ and docs/skills/setup) These directories document the Model Context Protocol (MCP) server implementation that AI agents interact with, including skill configuration and custom agent setup instructions linked from the main README.

Source Code Documentation Structure

Beyond markdown guides, OpenSEO includes extensive inline documentation within the source tree:

• src/serverFunctions/ – Contains server-side API implementations for keyword research, rank tracking, and SEO analysis functions
• src/lib/ – Houses core library utilities including authentication handlers, self-hosting detection logic (isSelfHost checks), and the MCP client implementation

Quick Start Examples from the Documentation

The documentation provides copy-paste commands for common scenarios:

Docker Self-Hosting Setup

# Copy the example environment file

cp .env.example .env

# Add your DataForSEO API key (see docs/DATAFORSEO_API_KEY.md)

# Then start the containers

docker compose up -d

Local Development Environment

# Install dependencies

pnpm install

# Run the dev server (see docs/LOCAL_DEVELOPMENT.md)

pnpm dev

MCP Client Integration

import { createMcpClient } from '@every-app/sdk';

const client = createMcpClient({
  baseUrl: 'http://localhost:3001/mcp',
  apiKey: process.env.OPENSEO_MCP_API_KEY,
});

// Example: fetch keyword rankings
const rankings = await client.getKeywordRankings({ projectId: 'proj_123' });

Summary

• Primary documentation lives in the repository's docs/ directory and README.md
• Self-hosting options are documented separately for Docker (SELF_HOSTING_DOCKER.md) and Cloudflare Workers (SELF_HOSTING_CLOUDFLARE.md)
• API setup requires following DATAFORSEO_API_KEY.md before running the application
• Source code reference is available in src/serverFunctions/ (API logic) and src/lib/ (utilities)
• AI agent integration is documented in the docs/mcp/ and skills subdirectories

Frequently Asked Questions

Where is the OpenSEO API documentation located?

The API documentation is distributed across docs/DATAFORSEO_API_KEY.md for external SEO data configuration and inline code comments within src/serverFunctions/ for internal API implementations. The MCP server endpoints are documented in the docs/mcp/ directory.

Do I need to read all the documentation files to self-host OpenSEO?

No, you only need the guide matching your deployment target. Read docs/SELF_HOSTING_DOCKER.md for containerized deployments or docs/SELF_HOSTING_CLOUDFLARE.md for edge deployment. Both require docs/DATAFORSEO_API_KEY.md for API configuration.

What is the difference between the README and the docs folder?

The README.md provides the architectural overview and navigation links to specialized guides, while the docs/ directory contains actionable implementation guides for specific tasks like Docker setup, local development, and API key configuration.

How do I find documentation for building custom AI agent skills?

Custom agent skill documentation resides in docs/skills/setup and the docs/mcp/ directory, referenced from lines 39-44 of the main README. These files explain how to configure the MCP server and extend OpenSEO's capabilities for AI agent interactions.

{
  "mcpServers": {
    "instagit": {
      "command": "npx",
      "args": ["-y", "instagit@latest"]
    }
  }
}