Skip to main content

FAOS MCP Tools Reference

Complete reference for all 17 FAOS MCP tools available in Claude Desktop.

Tool Categories​

CategoryToolsPurpose
Agent Invocation1Invoke specialist AI agents
Workflow Execution4Run multi-step workflows
Context & Stories4Access project context and stories
Activity Tracking2Log activities and get tasks
Metrics3Query business metrics
Knowledge Graph3Query knowledge relationships

Agent Invocation​

faos_invoke_agent​

Invoke a FAOS specialist agent to perform a task. Supports intelligent auto-routing.

Parameters:

ParameterTypeRequiredDefaultDescription
agent_idstringNo"auto"Agent ID or "auto" for intelligent routing
taskstringYes-Natural language task description
contextobjectNo{}Additional context (files, state, data)
streambooleanNotrueStream response progressively

Available Agents:

Agent IDSpecialtyBest For
autoIntelligent RoutingLet FAOS pick the best agent
pmProduct ManagementPRDs, requirements, stakeholder comms
devDevelopmentCode review, implementation, debugging
architectArchitectureSystem design, ADRs, tech decisions
analystAnalysisResearch, market analysis, requirements
smScrum MasterSprint planning, story management

Response:

{
"content": "Agent's response text...",
"agent_id": "pm",
"artifacts": [],
"tool_calls": [],
"session_id": "sess_abc123"
}

Examples:

Simple invocation:

"Use the FAOS dev agent to review this code for security vulnerabilities"

Auto-routing (recommended):

"Ask FAOS to help me design a REST API for user authentication"

Claude will automatically route to the architect agent.

With context:

"Use FAOS PM agent to review my PRD. Here's the draft: [paste PRD]. Focus on acceptance criteria completeness."

Iterative refinement:

  1. "Ask FAOS analyst to research competitor pricing strategies"
  2. "Now have the PM agent incorporate this into our pricing section"
  3. "Finally, ask the architect to validate technical feasibility"

Workflow Execution​

faos_run_workflow​

Execute a multi-step FAOS workflow. Workflows automate complex processes like PRD creation or code review.

Parameters:

ParameterTypeRequiredDefaultDescription
workflow_idstringYes-Workflow identifier
inputsobjectNo{}Workflow-specific inputs
wait_for_completionbooleanNofalseWait for completion (may timeout)

Available Workflows:

Workflow IDDescriptionDurationKey Inputs
create-prdCreate Product Requirements Document30-60 minproduct_name, target_users
create-architectureDesign system architecture45-90 minprd_content, constraints
create-storyCreate user story from epic10-20 minepic_id, story_title
sprint-planningPlan sprint from backlog5-15 minsprint_number, capacity
code-reviewComprehensive code review15-30 minfile_paths, focus_areas
create-tech-specTechnical specification20-40 minstory_id, requirements
create-epics-and-storiesBreak down PRD to epics30-45 minprd_content
implementation-readinessValidate before dev10-15 minstory_id

Response (async):

{
"workflow_run_id": "wfrun_abc123",
"workflow_id": "create-prd",
"status": "running",
"progress": 15,
"message": "Gathering requirements..."
}

Examples:

Start a PRD workflow:

"Run the FAOS create-prd workflow for a mobile expense tracking app"

With specific inputs:

"Run FAOS code-review workflow on src/auth/*.py focusing on security and error handling"

Synchronous (short workflows):

"Run FAOS sprint-planning workflow for sprint 15 with 40 story points capacity and wait for completion"


faos_get_workflow_status​

Check the status of a running workflow.

Parameters:

ParameterTypeRequiredDescription
workflow_run_idstringYesRun ID from faos_run_workflow

Response:

{
"workflow_run_id": "wfrun_abc123",
"workflow_id": "create-prd",
"status": "running",
"progress": 45,
"current_step": "Defining user personas",
"output": null
}

Status Values:

  • pending - Queued, not yet started
  • running - Currently executing
  • completed - Finished successfully
  • failed - Encountered error
  • cancelled - Cancelled by user

Example:

"Check the status of FAOS workflow wfrun_abc123"


faos_cancel_workflow​

Cancel a running workflow gracefully.

Parameters:

ParameterTypeRequiredDescription
workflow_run_idstringYesRun ID to cancel

Response:

{
"workflow_run_id": "wfrun_abc123",
"status": "cancelled",
"message": "Workflow cancelled at step 3",
"partial_output": "..."
}

Example:

"Cancel FAOS workflow wfrun_abc123"


faos_list_workflows​

List all available workflows with their specifications.

Parameters: None

Response:

{
"workflows": [
{
"workflow_id": "create-prd",
"name": "Create PRD",
"description": "Create comprehensive Product Requirements Document",
"estimated_duration": "30-60 min",
"required_inputs": ["product_name"],
"optional_inputs": ["target_users", "competitors"]
}
],
"count": 8
}

Example:

"List all available FAOS workflows"


Context & Stories​

faos_get_context​

Get current sprint and project context.

Parameters:

ParameterTypeRequiredDefaultDescription
projectIdstringNoInferredProject ID

Response:

{
"sprint": {
"number": 15,
"goal": "Complete authentication module",
"start_date": "2026-01-20",
"end_date": "2026-02-03"
},
"project": {
"name": "FAOS Platform",
"key": "faos"
},
"activeStories": [
{"key": "55-6", "title": "Claude Desktop Integration Guide", "status": "in-progress"}
]
}

Example:

"Get current FAOS sprint context"


faos_get_story​

Get full details of a specific story.

Parameters:

ParameterTypeRequiredDescription
storyKeystringYesStory key (e.g., "55-6")

Response:

{
"key": "55-6",
"title": "Claude Desktop Integration Guide",
"status": "in-progress",
"acceptance_criteria": [...],
"tasks": [...],
"dev_notes": "..."
}

Example:

"Get details for FAOS story 55-6"


faos_search_decisions​

Search architecture decisions (ADRs).

Parameters:

ParameterTypeRequiredDescription
querystringYesSearch query

Response:

{
"decisions": [
{
"id": "ADR-001",
"title": "Use PostgreSQL for primary database",
"status": "accepted",
"context": "...",
"decision": "..."
}
]
}

Example:

"Search FAOS decisions for database selection"


faos_get_guidelines​

Get coding guidelines by category.

Parameters:

ParameterTypeRequiredDefaultDescription
categorystringNo"all"Category filter

Categories: testing, api, security, database, performance, frontend, backend, deployment, all

Example:

"Get FAOS security guidelines"


Activity Tracking​

faos_log_activity​

Log developer activity for tracking and analytics.

Parameters:

ParameterTypeRequiredDescription
activityTypestringYesActivity type (see below)
filePathstringNoAffected file path
payloadobjectNoAdditional data
idempotencyKeystringNoPrevent duplicates

Activity Types:

  • artifact:created, artifact:updated
  • file:create, file:update, file:delete
  • tool:edit, tool:write, tool:bash
  • prompt:submit
  • session:start, session:stop

Example:

"Log a FAOS activity: I created the authentication module"


faos_get_my_tasks​

Get your assigned tasks from the current sprint.

Parameters:

ParameterTypeRequiredDefaultDescription
statusstringNo"all"Filter: all, in-progress, ready-for-dev, review
limitintegerNo10Max results (1-100)

Example:

"Show my FAOS tasks that are in-progress"


Metrics​

faos_query_metric​

Query a business metric with optional filters.

Parameters:

ParameterTypeRequiredDescription
metric_namestringYesMetric name
tenant_idstringYesTenant ID
dimensionsobjectNoFilter dimensions
time_grainstringNominute, hour, day, week, month, quarter, year, all
start_datestringNoISO date
end_datestringNoISO date

Example:

"Query FAOS metric 'monthly_active_users' for January 2026"


faos_list_metrics​

List available metrics in the catalog.

Parameters:

ParameterTypeRequiredDescription
tenant_idstringYesTenant ID
categorystringNoCategory filter

Example:

"List all available FAOS metrics"


faos_get_metric_definition​

Get full metric definition including calculation logic.

Parameters:

ParameterTypeRequiredDescription
metric_namestringYesMetric name
tenant_idstringYesTenant ID

Example:

"Get the definition for FAOS metric 'customer_lifetime_value'"


Knowledge Graph​

faos_query_graph​

Query the knowledge graph with multi-hop traversal.

Parameters:

ParameterTypeRequiredDefaultDescription
start_entitystringYes-Starting entity ID/name
tenant_idstringYes-Tenant ID
max_hopsintegerNo2Traversal depth (1-10)
relationship_typesarrayNoallFilter by relationship types
directionstringNo"both"in, out, both
node_typesarrayNoallFilter by node types
include_explanationbooleanNofalseInclude query explanation

Example:

"Query FAOS knowledge graph starting from 'AuthenticationService' to find its dependencies"


faos_nl_graph_query​

Query knowledge graph using natural language.

Parameters:

ParameterTypeRequiredDescription
questionstringYesNatural language question
tenant_idstringYesTenant ID
include_cypherbooleanNoInclude generated Cypher

Example:

"Ask FAOS knowledge graph: What components depend on the PaymentService?"


faos_explain_graph_query​

Explain a Cypher query without executing.

Parameters:

ParameterTypeRequiredDescription
cypherstringYesCypher query to explain
tenant_idstringYesTenant ID

Example:

"Explain this FAOS graph query: MATCH (n)-[:DEPENDS_ON]->(m) RETURN n, m"


Common Patterns​

Iterative Agent Workflow​

  1. Start with research: "Ask FAOS analyst to research [topic]"
  2. Create structure: "Have FAOS PM create an outline based on that research"
  3. Add technical details: "Ask FAOS architect to add technical specifications"
  4. Review: "Have FAOS dev review for implementation feasibility"

Workflow + Status Check Pattern​

1. "Run FAOS create-prd workflow for [product]"
β†’ Returns workflow_run_id

2. [Wait a few minutes]

3. "Check status of FAOS workflow [workflow_run_id]"
β†’ Shows progress and current step

4. [Repeat until completed]

5. "Get the output of completed FAOS workflow [workflow_run_id]"

Context-Aware Development​

1. "Get my FAOS tasks"
β†’ See assigned stories

2. "Get details for FAOS story [key]"
β†’ Understand requirements

3. "Get FAOS security guidelines"
β†’ Ensure compliance

4. "Ask FAOS dev agent to help implement [story requirements]"
β†’ Get implementation guidance

Error Handling​

Error CodeMeaningSolution
401Authentication failedCheck/refresh token
403Insufficient permissionsCheck token scopes
404Resource not foundVerify IDs/keys
429Rate limit exceededWait and retry
500Server errorContact support

See Troubleshooting for detailed error resolution.