Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .env.example
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ OUTLINE_API_KEY=your_outline_api_key_here
# Access Control
# OUTLINE_READ_ONLY=true # Disable all write operations (search/read only)
# OUTLINE_DISABLE_DELETE=true # Disable delete operations only
# OUTLINE_DYNAMIC_TOOL_LIST=true # Enable per-request tool filtering (off by default)
# OUTLINE_DYNAMIC_TOOL_LIST=true # Enable per-user tool filtering (off by default)

# MCP Server Configuration
# MCP_TRANSPORT=stdio # Default: stdio (for direct process communication)
Expand Down
18 changes: 10 additions & 8 deletions .github/workflows/claude-code-review.yml
Original file line number Diff line number Diff line change
@@ -1,14 +1,16 @@
name: Claude Code Review

# Disabled — uncomment triggers below to re-enable
on:
pull_request:
types: [opened, synchronize, ready_for_review, reopened]
# Optional: Only run on specific file changes
# paths:
# - "src/**/*.ts"
# - "src/**/*.tsx"
# - "src/**/*.js"
# - "src/**/*.jsx"
workflow_dispatch: {}
# pull_request:
# types: [opened, synchronize, ready_for_review, reopened]
# # Optional: Only run on specific file changes
# # paths:
# # - "src/**/*.ts"
# # - "src/**/*.tsx"
# # - "src/**/*.js"
# # - "src/**/*.jsx"

jobs:
claude-review:
Expand Down
18 changes: 10 additions & 8 deletions .github/workflows/claude.yml
Original file line number Diff line number Diff line change
@@ -1,14 +1,16 @@
name: Claude Code

# Disabled — uncomment triggers below to re-enable
on:
issue_comment:
types: [created]
pull_request_review_comment:
types: [created]
issues:
types: [opened, assigned]
pull_request_review:
types: [submitted]
workflow_dispatch: {}
# issue_comment:
# types: [created]
# pull_request_review_comment:
# types: [created]
# issues:
# types: [opened, assigned]
# pull_request_review:
# types: [submitted]

jobs:
claude:
Expand Down
6 changes: 3 additions & 3 deletions CLAUDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ install_dynamic_tool_list(mcp) # If OUTLINE_DYNAMIC_TOOL_LIST=

### Common Utilities (`features/documents/common.py`)

- `get_outline_client()` - Async function that creates an OutlineClient. Checks for a per-request API key from the `x-outline-api-key` HTTP header first (SSE/streamable-http), then falls back to `OUTLINE_API_KEY` env var.
- `get_outline_client()` - Async function that creates an OutlineClient. Checks for a per-user Outline API key from the `x-outline-api-key` HTTP header first (SSE/streamable-http), then falls back to `OUTLINE_API_KEY` env var.
- `_get_header_api_key()` - Reads the `x-outline-api-key` header from the MCP SDK's `request_ctx` ContextVar. Returns `None` for stdio or when header is absent.
- `OutlineClientError` - Exception class for client-related errors

Expand Down Expand Up @@ -318,7 +318,7 @@ OUTLINE_WRITE_TIMEOUT=30.0 # Write timeout in seconds
OUTLINE_DISABLE_AI_TOOLS=true # Disable AI tools
OUTLINE_READ_ONLY=true # Disable all write operations
OUTLINE_DISABLE_DELETE=true # Disable delete operations only
OUTLINE_DYNAMIC_TOOL_LIST=true # Enable per-request tool filtering (requires apiKeys.list scope)
OUTLINE_DYNAMIC_TOOL_LIST=true # Enable per-user tool filtering (requires apiKeys.list scope)

# MCP server (optional)
MCP_TRANSPORT=stdio # Transport: stdio, sse, streamable-http
Expand All @@ -329,7 +329,7 @@ MCP_PORT=3000 # Server port
**Access Control Notes**:
- `OUTLINE_READ_ONLY`: Blocks entire write modules at registration (content, lifecycle, organization, batch_operations)
- `OUTLINE_DISABLE_DELETE`: Conditionally registers delete tools within document_lifecycle and collection_tools
- `OUTLINE_DYNAMIC_TOOL_LIST`: Off by default. Uses `apiKeys.list` to introspect API key scopes and filters tools per-request based on scope matching. Scoped API keys must include `apiKeys.list` in their scope array for introspection to work. Fail-open: if scope introspection fails, all tools are shown. Set to `true` to enable.
- `OUTLINE_DYNAMIC_TOOL_LIST`: Off by default. Uses `apiKeys.list` to introspect API key scopes and filters tools per-user based on scope matching. Scoped API keys must include `apiKeys.list` in their scope array for introspection to work. Fail-open: if scope introspection fails, all tools are shown. Set to `true` to enable.
- Read-only mode takes precedence: If both are set, server operates in read-only mode

### Critical Requirements
Expand Down
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ git clone https://github.com/YOUR_USERNAME/mcp-outline.git
cd mcp-outline

# 2. Install dependencies
uv sync --extra dev
uv sync --group dev

# 3. Install pre-commit hooks (important!)
uv run pre-commit install
Expand All @@ -35,7 +35,7 @@ If you want to run checks before committing:
uv run ruff format . # Format code
uv run ruff check . # Lint code
uv run pyright src/ # Type check
uv run pytest tests/ -v # Run tests
uv run poe test-unit # Run tests
```

## Questions?
Expand Down
Loading