Skip to content

docs: add agent rules example to README#655

Open
Deepak7704 wants to merge 2 commits intomainfrom
feat/650
Open

docs: add agent rules example to README#655
Deepak7704 wants to merge 2 commits intomainfrom
feat/650

Conversation

@Deepak7704
Copy link
Copy Markdown
Collaborator

@Deepak7704 Deepak7704 commented Mar 24, 2026

Summary

  • Add a new "Agent Rules Example" section to the README
  • Demonstrates how to configure agentRules for project-specific coding conventions
  • Provides a concrete example showing inline rules that are automatically included in every agent prompt

Test plan

  • README renders correctly with new example section
  • YAML example uses valid configuration fields from ProjectConfig schema

Closes #650

Add a new example section demonstrating GraphQL batching configuration in agent-orchestrator.yaml. This example shows how to enable batch queries for projects using GraphQL APIs.

Closes #650
Copilot AI review requested due to automatic review settings March 24, 2026 12:59
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds a new documentation section to the README intended to show how to configure GraphQL request batching in agent-orchestrator.yaml.

Changes:

  • Added a “GraphQL Batching Example” section under Configuration
  • Included a YAML snippet demonstrating batchQueries, maxBatchSize, and batchInterval

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread README.md Outdated
Comment on lines +139 to +158
### GraphQL Batching Example

For projects that use GraphQL, you can configure the orchestrator to batch related queries and mutations for efficiency:

```yaml
# agent-orchestrator.yaml
projects:
my-graphql-app:
repo: owner/my-graphql-app
path: ~/my-graphql-app
defaultBranch: main
settings:
graphql:
batchQueries: true
maxBatchSize: 10
batchInterval: 100ms
```

This configuration enables automatic batching of GraphQL requests when the agent interacts with your GraphQL API, reducing network overhead and improving performance.

Copy link

Copilot AI Mar 24, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The README introduces projects.<id>.settings.graphql with batchQueries/maxBatchSize/batchInterval and claims the orchestrator will batch GraphQL requests, but these keys don’t appear to exist in the current configuration schema (e.g., ProjectConfig in packages/core/src/types.ts and agent-orchestrator.yaml.example don’t define a settings or graphql section). As written, this example will likely produce an “unknown config key”/validation error and mislead users. Please either (1) update the example to use real, supported config fields, or (2) land the corresponding config + implementation changes and add the new fields to the schema/example config before documenting them here.

Suggested change
### GraphQL Batching Example
For projects that use GraphQL, you can configure the orchestrator to batch related queries and mutations for efficiency:
```yaml
# agent-orchestrator.yaml
projects:
my-graphql-app:
repo: owner/my-graphql-app
path: ~/my-graphql-app
defaultBranch: main
settings:
graphql:
batchQueries: true
maxBatchSize: 10
batchInterval: 100ms
```
This configuration enables automatic batching of GraphQL requests when the agent interacts with your GraphQL API, reducing network overhead and improving performance.

Copilot uses AI. Check for mistakes.
Replace non-existent GraphQL batching config with a valid agentRules example that uses supported ProjectConfig fields.

Addresses review comment on PR #655.
@Deepak7704
Copy link
Copy Markdown
Collaborator Author

Thanks for catching that! I've updated the example to use a valid agentRules configuration field that exists in the ProjectConfig schema. The new example demonstrates how to define agent-specific coding conventions that will be included in every agent prompt.

@Deepak7704 Deepak7704 changed the title docs: add GraphQL batching example to README docs: add agent rules example to README Mar 24, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Test Issue 2 - Update README documentation

2 participants