Documentation

MCP Integration

MCP (Model Context Protocol) is the standard for connecting AI assistants to external tools. Instructionly uses MCP to deliver your instructions to AI-powered IDEs.

Getting Your MCP Credentials

  1. Go to Settings > MCP Keys
  2. Click Create MCP Key
  3. Enter a name for the key
  4. Select an expiration period (1 day, 7 days, 15 days, 30 days, or No expiry)
  5. Click Create
  6. Copy your secret immediately — it's only shown once

Your MCP Key consists of:

  • MCP Key ID — The public identifier
  • MCP Secret — The private key (shown only once)
  • Expiration — When the key will stop working (optional)
Key expiration

For security, consider setting an expiration on your keys. Expired keys are automatically rejected and you'll need to create a new one.

Using MCP Keys

Add Instructionly to your AI tool's MCP configuration. First, install the CLI, then add this configuration:

json
{
  "mcpServers": {
    "instructionly": {
      "command": "instructionly",
      "env": {
        "MCP_KEY_ID": "YOUR_KEY_ID",
        "MCP_SECRET": "YOUR_SECRET",
        "MCP_WORKSPACE": "YOUR_WORKSPACE_SLUG"
      }
    }
  }
}

Replace the environment variables with your credentials:

  • MCP_KEY_ID — Your MCP Key ID
  • MCP_SECRET — Your MCP Secret
  • MCP_WORKSPACE — Your workspace slug
MCP keys are user-scoped

MCP keys are tied to your user account, not individual workspaces. Use the same key with different workspace values to access multiple workspaces.

Revoking MCP Keys

If a key is compromised:

  1. Go to Settings > MCP Keys
  2. Find the key to revoke
  3. Click Revoke
  4. Confirm the action

The key will immediately stop working.

Using ion

Once configured, you can activate Instructionly in two ways:

Option 1: Simply mention "ion" in your prompt — the AI will automatically use Instructionly:

prompt
ion how should I implement authentication in this project?

Option 2: Use the built-in MCP prompt command to explicitly invoke Instructionly:

prompt
/instructionly/ion how should I implement authentication in this project?

Instructionly will:

  1. Analyze your request
  2. Load relevant skills from your workspace
  3. Apply matching instructions
  4. Return AI-ready guidance

Available MCP Tools

When connected, your AI assistant has access to these Instructionly tools:

Tool Description
ion Delivers Instructionly workflow instructions to your AI assistant
inspector Analyzes your request to determine which skills and actions apply
directives Retrieves actionable instructions based on detected skills
restore_context Restores session context after conversation compaction
wrap_up Reviews work for instruction compliance before finalizing
check_balance Shows your current credit balance
check_usage Displays recent credit consumption history
list_skills Shows available skills in your workspace
get_help Provides documentation and support resources
service_status Checks Instructionly platform health
workspace_info Shows workspace details and statistics
notify_checkpoint Sends notification when task completes or needs user input
set_checkpoint_notification Updates notification preference mid-session

How Instructions Are Applied

When you use ion, the following process occurs:

  1. Request Analysis — The inspector tool analyzes your prompt to identify the action type (code, test, review, etc.)
  2. Skill Matching — Relevant skills are matched based on the detected action
  3. Instruction Loading — Instructions from matched skills are loaded
  4. Context Injection — Instructions are provided to your AI assistant as context
  5. Credit Consumption — Credits are deducted based on usage