Skip to content

Latest commit

 

History

History

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 

README.md

Index Server Knowledge Plugin Example

This is a local Squad plugin example for integrating with the real Index Server project: https://github.com/jagilber-org/index-server.

Index Server is a governed MCP knowledge base for AI agents. It indexes instructions and shared knowledge with search, CRUD, validation, versioning, audit trails, approval workflows, and cross-repo knowledge promotion. It is not a Squad memory provider, but it is adjacent to memory because agents can use it to persist and retrieve validated knowledge across sessions and repositories.

It demonstrates:

  • declaring Squad knowledge and instructions components
  • recording upstream package metadata for npm package @jagilber-org/index-server
  • documenting the optional index-server MCP server without starting it
  • keeping the Squad/MCP boundary intact

Try it

squad plugin validate .
squad plugin dry-run .
squad plugin install .
squad plugin enable index-server-knowledge
squad plugin switch knowledge index-server-knowledge
squad plugin list --json

Real Index Server setup

Install and configure Index Server separately from the Squad plugin lifecycle:

npm install -g @jagilber-org/index-server
index-server --setup
index-server --dashboard

Copilot CLI MCP configuration can use:

{
  "mcpServers": {
    "index-server": {
      "type": "stdio",
      "command": "npx",
      "args": ["-y", "@jagilber-org/index-server@latest", "--dashboard"],
      "env": {
        "INDEX_SERVER_DIR": "C:/mcp/index-data/instructions",
        "INDEX_SERVER_LOG_LEVEL": "info"
      },
      "tools": ["*"]
    }
  }
}

Important

This example is declarative only. Squad does not install @jagilber-org/index-server, run index-server, start MCP, mutate MCP client config, or execute Index Server code during plugin install.